|
Keel 2.1RC2 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
| Field Summary | |
static java.lang.String |
ROLE |
| Method Summary | |
void |
addError(java.lang.String errorName, java.lang.String errorMessage)Add an error with a specific name. |
void |
copyFrom(KeelRequest newRequest)Copy the values from another Keel Request into this one. |
ModelResponse |
createResponse()Used by the model to generate the "empty" response object, which the model then populates with Inputs, Outputs and Commands |
ModelResponse |
execute()Actually execute the requested model object's logic, returning the ModelResponse it creates |
java.lang.Object |
getConfiguration()Get the configuration object for this Request's Model |
Context |
getContext()Get the Keel Context object indiciating the current context for this request. |
java.lang.Object |
getDefaultService(java.lang.String role)This method is used by Model objects to get access to other services or services in the system. |
java.lang.String |
getDomain() |
java.util.Map |
getErrors()Return a map of error names and messages produced by validation of the parameters before entering this model. |
java.lang.Object[] |
getParameterAsArray(java.lang.String name)Return the values of a multi-valued parameter as an array of objects. |
java.util.Date |
getParameterAsDate(java.lang.String name)Return the value of the specified parameter as a date |
java.util.Date |
getParameterAsDate(java.lang.String name, java.util.Date defaultValue)Return the specified parameter's value as a date, or the default value if no such parameter exists. |
double |
getParameterAsDouble(java.lang.String name)Return the specified parameter's value as a double |
double |
getParameterAsDouble(java.lang.String name, double defaultValue) |
float |
getParameterAsFloat(java.lang.String name)Return the value of a parameter as a float |
float |
getParameterAsFloat(java.lang.String name, float defaultValue)Return the specified parameter's value as a float |
int |
getParameterAsInt(java.lang.String name)Get the named parameter as an int. |
int |
getParameterAsInt(java.lang.String name, int defaultValue)Return the specified parameter as an integer, returning the supplied default value if no such parameter exists. |
java.util.List |
getParameterAsList(java.lang.String name)Return the values of a parameter which has more than one value |
java.util.List |
getParameterAsList(java.lang.String name, java.util.List defaultValue)Return the values of a parameter which has more than one value |
long |
getParameterAsLong(java.lang.String name)Return the specified parameter as a long |
long |
getParameterAsLong(java.lang.String name, long defaultValue)Return the specified parameter as a long, or the default value if there is no such parameter. |
java.lang.String |
getParameterAsString(java.lang.String name)Return the specified parameter's value as a string |
java.lang.String |
getParameterAsString(java.lang.String name, java.lang.String defaultValue) |
java.util.Map |
getPreviousRequest()A request for a model may involve a jump to another model, or back to the same model in the event of an error (for the user to input new data, for example). |
java.lang.Object |
getService(java.lang.String role, java.lang.String hint)This method is used by a model when it wants to access a particular service (often a factory for another service) and specify the hint itself. |
java.lang.Object |
getService(java.lang.String role, java.lang.String hint, Context ctx)This method is used by a model when it wants to access a particular service (often a factory for another service) and specify the hint itself. |
int |
getUid()Return the user identifier of the user who has submitted this request. |
void |
setPreviousRequest(java.util.Map newPrevious) |
| Methods inherited from interface org.keel.services.model.KeelRequest |
deserialize, getAttribute, getAttributes, getModel, getParameter, getParameters, serialize, setAttribute, setModel, setParameter |
| Field Detail |
public static final java.lang.String ROLE
| Method Detail |
public ModelResponse execute()
throws ModelException
ModelException
public ModelResponse createResponse()
throws ModelException
ModelException
public Context getContext()
throws ModelException
ModelException
public java.lang.Object getDefaultService(java.lang.String role)
throws ModelException
ModelException
public java.lang.Object getService(java.lang.String role,
java.lang.String hint)
throws ModelException
ModelException
public java.lang.Object getService(java.lang.String role,
java.lang.String hint,
Context ctx)
throws ModelException
ModelExceptionpublic int getUid()
public java.lang.String getDomain()
public java.util.Map getPreviousRequest()
public void setPreviousRequest(java.util.Map newPrevious)
public java.lang.Object getConfiguration()
public void copyFrom(KeelRequest newRequest)
throws ModelException
newRequest - The request to copy fromModelException - If an error occurs during the copypublic int getParameterAsInt(java.lang.String name)
name - Name of the required parameter
public int getParameterAsInt(java.lang.String name,
int defaultValue)
name - Name of the required parameterdefaultValue - The value returned if no such parameter existspublic long getParameterAsLong(java.lang.String name)
name - Name of the required parameter
public long getParameterAsLong(java.lang.String name,
long defaultValue)
name - Name of the required parameterdefaultValue - The value to be returned if no such parameter existspublic float getParameterAsFloat(java.lang.String name)
name - Name of the required parameter
public float getParameterAsFloat(java.lang.String name,
float defaultValue)
name - Name of the required parameterdefaultValue -public double getParameterAsDouble(java.lang.String name)
name - Name of the required parameter
public double getParameterAsDouble(java.lang.String name,
double defaultValue)
name - Name of the required parameterdefaultValue -public java.lang.String getParameterAsString(java.lang.String name)
name - Name of the required parameter
public java.lang.String getParameterAsString(java.lang.String name,
java.lang.String defaultValue)
name - Name of the required parameterdefaultValue -public java.lang.Object[] getParameterAsArray(java.lang.String name)
name - Name of the required parameterpublic java.util.Date getParameterAsDate(java.lang.String name)
name - Name of the required parameter
public java.util.Date getParameterAsDate(java.lang.String name,
java.util.Date defaultValue)
name - Name of the required parameterdefaultValue - The date value to return if no such parameter existspublic java.util.List getParameterAsList(java.lang.String name)
name - Name of the required parameter
public java.util.List getParameterAsList(java.lang.String name,
java.util.List defaultValue)
name - Name of the required parameterdefaultValue - The list returned if no such parameter exists.public java.util.Map getErrors()
public void addError(java.lang.String errorName,
java.lang.String errorMessage)
errorName - A name for this error message, which may (or may not) correspond to the UI element from which the error originated.errorMessage - A human-readable error message to be displayed to the user. Messages beginning with "$" will be taken to be internationalized keys to look up in the appropriate message bundle for this locale.
|
Keel 2.1RC2 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||