ViewCommand is the base interface that defines the signature of all commands that retrieve views from the database. The web controller calls the setCommandContext method and the setRequestPropperties method of a view command before calling the execute method.
Two additional methods are required for a ViewCommand in addition to the basic ECCommand. setRequestProperties - this is called before the execute method to set up the request parameters getResponseProperties - this is called after the execute method to get all the response data
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Method Summary | |
---|---|
TypedProperty |
getRequestProperties() Gets the request properties . |
TypedProperty |
getResponseProperties() |
java.lang.String |
getViewName() Gets the view task name name for this view command. |
TypedProperty |
mergeProperties(
TypedProperty reqProp,
TypedProperty resProp) Merges the request properties to the controller command, the response properties returned from the controller command and the default properties associated with this view command. |
void |
setRequestProperties(
TypedProperty param) Sets the request properties for this command. |
void |
setViewName(java.lang.String value) Sets the view task name name for this view command. |
Methods inherited from interface com.ibm.commerce.command. AccCommand |
accessControlCheck,
getAccCheck,
getForUserId,
getResourceOwners,
setAccCheck,
setForUserId,
setOwner |
Methods inherited from interface com.ibm.commerce.command. ECCommand |
checkIsAllowed,
checkResourcePermission,
createCommandExecutionEvent,
execute,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
performExecute,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties,
validateParameters |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Method Detail |
---|
public TypedProperty getRequestProperties()
public TypedProperty getResponseProperties()
public java.lang.String getViewName()
public TypedProperty mergeProperties(TypedProperty reqProp, TypedProperty resProp)
reqProp
- the request properties passed to the controller
commandresProp
- the response properties returned by the controller
commandpublic void setRequestProperties(TypedProperty param) throws ECException
ECException
public void setViewName(java.lang.String value)
value
- view name