com.ibm.commerce.command
Interface ViewCommand

All Superinterfaces:
AccCommand, ECCommand, Protectable
All Known Subinterfaces:
DirectViewCommand, ForwardViewCommand, IndirectViewCommand, RedirectViewCommand, ToolsForwardViewCommand
All Known Implementing Classes:
AbstractViewCommand

public interface ViewCommand
extends AccCommand

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
           
 
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
 
Method Summary
 TypedProperty getRequestProperties()
          Gets the request properties .
 TypedProperty getResponseProperties()
           
 java.lang.String getViewName()
          Get the view task name name for this view command.
 TypedProperty mergeProperties(TypedProperty reqProp, TypedProperty resProp)
          The method 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, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Method Detail

getRequestProperties

public TypedProperty getRequestProperties()
Gets the request properties .
Returns:
TypedProperties

getResponseProperties

public TypedProperty getResponseProperties()

getViewName

public java.lang.String getViewName()
Get the view task name name for this view command. This is an internal method used by the command framework.
Returns:
String - view name

mergeProperties

public TypedProperty mergeProperties(TypedProperty reqProp,
                                     TypedProperty resProp)
The method 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.

Parameters:
reqProp - TypedProperty - this is the request properties passed to the controller command
resProp - TypedProperty - this is the response properties returned by the controller command
Returns:
TypedProperty - this will become the request properties for this command

setRequestProperties

public void setRequestProperties(TypedProperty param)
                          throws ECException
Sets the request properties for this command.
Parameters:
name - java.lang.String

setViewName

public void setViewName(java.lang.String value)
Sets the view task name name for this view command. This is an internal method used by the command framework.
Parameters:
value - String - view name