com.ibm.commerce.command

Interface ViewCommand

All Superinterfaces:

AccCommand, com.ibm.websphere.command.Command, ECCommand, Protectable, java.io.Serializable

All Known Subinterfaces:

DirectViewCommand, ForwardViewCommand, IndirectViewCommand, RedirectViewCommand, ToolsForwardViewCommand

All Known Implementing Classes:

AbstractDirectViewCommand, AbstractForwardViewCommand, AbstractIndirectViewCommand, AbstractRedirectViewCommand, AbstractViewCommand, HttpDirectViewCommandImpl, HttpForwardViewCommandImpl, HttpIndirectForwardViewCommandImpl, HttpRedirectViewCommandImpl, HttpRedirectViewCommandNoEncryptionImpl, HttpsRedirectViewCommandImpl, RedirectViewCommandImpl, ToolsForwardViewCommandImpl

public interface ViewCommand
extends AccCommand

This 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 method is called before the execute method to set up the request parameters.
• getResponseProperties - This method is called after the execute method to get all the response data.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from interface com.ibm.commerce.command.ECCommand

defaultCommandClassName

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
TypedProperty	getRequestProperties() This method gets the request properties.
TypedProperty	getResponseProperties() This method gets the response properties.
java.lang.String	getViewName() This method gets the view task name for this view command.
TypedProperty	mergeProperties(TypedProperty reqProp, TypedProperty resProp) This method merges three different types of properties.
void	setRequestProperties(TypedProperty param) This method sets the request properties for this command.
void	setViewName(java.lang.String value) This method sets the view task 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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

getRequestProperties

TypedProperty getRequestProperties()

This method gets the request properties.

Returns:

This method returns the request properties.

getResponseProperties

TypedProperty getResponseProperties()

This method gets the response properties.

Returns:

This method returns response properties.

getViewName

java.lang.String getViewName()

This method gets the view task name for this view command. This is an internal method used by the command framework.

Returns:

This method returns the view name .

mergeProperties

TypedProperty mergeProperties(TypedProperty reqProp,
                              TypedProperty resProp)

This method merges three different types of properties. They are the request properties of the controller command, the response properties of the controller command and the default properties associated with this view command.

Parameters:

reqProp - This is an object that represents the request properties passed to the controller command.

resProp - This is an object that represents the response properties returned by the controller command.

Returns:

This method returns request properties for this command.

setRequestProperties

void setRequestProperties(TypedProperty param)
                   throws ECException

This method sets the request properties for this command.

Parameters:

param - This is an object that represents the request properties.

Throws:

ECException

setViewName

void setViewName(java.lang.String value)

This method sets the view task name for this view command. This is an internal method used by the command framework.

Parameters:

value - This is the view name.