com.ibm.commerce.order.commands
Class OrderListCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.order.commands.OrderListCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, OrderListCmd

public class OrderListCmdImpl
extends ControllerCommandImpl
implements OrderListCmd

Default implementation of the OrderList controller command. Sets the "viewTaskName" response property to "OrderListPendingView", if the status input parameter is "P". Otherwise sets it to "OrderListNonPendingView" (unless it is "X", which is not allowed).

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
 
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.order.commands. OrderListCmd
defaultCommandClassName, NAME
 
Constructor Summary
OrderListCmdImpl()
           
 
Method Summary
protected  java.lang.String getStatus()
          Returns the value of the status input parameter.
 void performExecute()
          Executes the main business logic of the command.
 void reset()
          Resets instance variables to their initial values.
 void setRequestProperties( TypedProperty aRequestProperties)
          Extracts input parameters from the specified request properties.
 void setStatus(java.lang.String aStatus)
          Specifies the status of the Orders that are to be displayed.
 void setStoreId(java.lang.Integer aStoreId)
          Specifies the identifier of the Store whose Orders are to be displayed.
 void validateParameters()
          Validates the input parameters.
 
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
 
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, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright notice field.
See Also:
Constant Field Values
Constructor Detail

OrderListCmdImpl

public OrderListCmdImpl()
Method Detail

getStatus

protected java.lang.String getStatus()
Returns the value of the status input parameter.
Returns:
the status input parameter.

performExecute

public void performExecute()
                    throws ECException
Executes the main business logic of the command. Behaviour:
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECApplicationException - There is no current user in the command context. The _ERR_DIDNT_LOGON message is passed.
ECException -
See Also:
ECCommand.performExecute()

reset

public void reset()
Resets instance variables to their initial values.
Overrides:
reset in class AbstractECTargetableCommand

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Extracts input parameters from the specified request properties.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Parameters:
aRequestProperties - the request properties. The following request properties are recognized:
Throws:
ECApplicationException -
See Also:
ControllerCommand.setRequestProperties(TypedProperty)

setStatus

public void setStatus(java.lang.String aStatus)
Specifies the status of the Orders that are to be displayed.
Specified by:
setStatus in interface OrderListCmd
Parameters:
aStatus - the status of the Orders that are to be displayed.

setStoreId

public void setStoreId(java.lang.Integer aStoreId)
Specifies the identifier of the Store whose Orders are to be displayed.
Specified by:
setStoreId in interface OrderListCmd
Parameters:
aStoreId - the identifier of the Store whose Orders are to be displayed.

validateParameters

public void validateParameters()
                        throws ECException
Validates the input parameters.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECApplicationException - The _ERR_BAD_MISSING_CMD_PARAMETER message is passed, with the name of the invalid or missing property name.
ECException -
See Also:
ECCommand.validateParameters()