edu.uoc.pfc.j2ee.jalonsod.mtp.request
Interface RequestDataPrivate

All Superinterfaces:
RequestData
All Known Implementing Classes:
HttpRequestData

public interface RequestDataPrivate
extends RequestData

File: RequestDataPrivate.java Created: 2012-05-10 The API of the requestData private to components of MTP framework. The protocol implementations of the requestData must implements both RequestData and RequestDataPrivate.

Author:
José Alonso de Motta
See Also:
RequestData

Field Summary
static java.lang.String REQUEST_MODEL_ATTRIBUTE
          The request attribute name for the model instance object of application.
static java.lang.String SESSION_LANGUAGE_ATTRIBUTE
          The session attribute name for the language of the session.
static java.lang.String SESSION_ROLES_ATTRIBUTE
          The session attribute name for roles granted to a session.
 
Fields inherited from interface edu.uoc.pfc.j2ee.jalonsod.mtp.request.RequestData
MTP_LOGGER, REQUEST_EXCEPTION, REQUEST_REQUESTDATA_ATTRIBUTE, VALIDATION_ERROR_LOADING_PARAMETER_VALUES_INTO_MODEL, VALIDATION_ERROR_STAGE_1_DATATYPE_CONVERSION, VALIDATION_ERROR_STAGE_2_REQUIRED_FIELDS, VALIDATION_ERROR_STAGE_3_FIELD_VALIDATION_FUNCTIONS, VALIDATION_ERROR_STAGE_4_MODEL_VALIDATION_FUNCTION, VALIDATION_NO_VALIDATED, VALIDATION_OK
 
Method Summary
 void authorize(boolean authorized)
          Sets the request authorization status to run the model.
 void setFormInstance(FormInstance formInstance)
          Sets the formInstance object with the parameters of the request associated with the model.
 void setModel(Model model)
          Sets the model configuration object for the request.
 void setModelInstance(java.lang.Object modelInstance)
          Sets the application model object.
 void setModelResponse(java.lang.String modelResponse)
          Sets the response string returned by the run method of the application model object.
 void setResult(Result result)
          Sets the result object of the request.
 void setValidationStatus(int validationStatus)
          Sets the request validation status.
 void setView(java.lang.String view)
          Sets the view name to which response will be redirected.
 
Methods inherited from interface edu.uoc.pfc.j2ee.jalonsod.mtp.request.RequestData
createSession, deleteSessionAttribute, getConfigurator, getFormInstance, getLanguages, getMessage, getModel, getModelInstance, getModelResponse, getRequestAttribute, getRequestParameter, getResult, getRoles, getSessionAttribute, getUserLanguage, getValidationStatus, getView, hasValidSession, isAuthorized, isValidated, logoutSession, setRequestAttribute, setRoles, setSessionAttribute, setUserLanguage
 

Field Detail

SESSION_ROLES_ATTRIBUTE

static final java.lang.String SESSION_ROLES_ATTRIBUTE
The session attribute name for roles granted to a session. Use getRoles() to read it and setRoles() to set.

See Also:
RequestData.getRoles(), RequestData.setRoles(Hashtable), Constant Field Values

SESSION_LANGUAGE_ATTRIBUTE

static final java.lang.String SESSION_LANGUAGE_ATTRIBUTE
The session attribute name for the language of the session. Set with setUserLanguage().

See Also:
RequestData.getUserLanguage(), RequestData.setUserLanguage(Language), Constant Field Values

REQUEST_MODEL_ATTRIBUTE

static final java.lang.String REQUEST_MODEL_ATTRIBUTE
The request attribute name for the model instance object of application. Read with getModelInstance method.

See Also:
RequestData.getModelInstance(), Constant Field Values
Method Detail

setModel

void setModel(Model model)
Sets the model configuration object for the request.

This is done by the modelMapper.

Parameters:
model - the model configuration object to set into the request.
See Also:
Model

setModelInstance

void setModelInstance(java.lang.Object modelInstance)
Sets the application model object.

This is done by the modelMapper.

Parameters:
modelInstance - the application model object.
See Also:
ModelMapper

setFormInstance

void setFormInstance(FormInstance formInstance)
Sets the formInstance object with the parameters of the request associated with the model.

This is done in the validation stage by the validator.

Parameters:
formInstance - the formInstance object with the parameters of the request associated with the model.

setModelResponse

void setModelResponse(java.lang.String modelResponse)
Sets the response string returned by the run method of the application model object.

This is done by the framework when the model run method finishes.

Parameters:
modelResponse - the response string returned by the run method of the application model object.

setResult

void setResult(Result result)
Sets the result object of the request.

This is done by the viewMapper.

Parameters:
result - the result object of the request.
See Also:
ViewMapper

setView

void setView(java.lang.String view)
Sets the view name to which response will be redirected.

This is done by the viewMapper.

Parameters:
view -

authorize

void authorize(boolean authorized)
Sets the request authorization status to run the model.

This is done by the accessControl of the framework.

Parameters:
authorized - true if request is authorized, false otherwise.

setValidationStatus

void setValidationStatus(int validationStatus)
Sets the request validation status.

This is done by the framework in validation stage.

Parameters:
validationStatus - the validation status of the framework. It's one of the RequestData.VALIDATION_* values.