OrderListCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.ControllerCommandImpl
    - - com.ibm.commerce.order.commands.OrderListCmdImpl

All Implemented Interfaces:: AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, OrderListCmd, Protectable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class OrderListCmdImpl
extends ControllerCommandImpl
implements OrderListCmd

This is the default implementation of the OrderListCmd controller command.

Behavior:

It 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).
If the status is P, sets the OrderListPendingView view command to display the list of pending orders.
If the status is any value other than P (or X, which is considered a command error): sets the OrderListNonPendingView view command to display the list of orders that match the specified status for a store (if any).

Input parameters:

Name	Description
`langId`	Sets or resets the preferred language for the duration of the session; the supported languages for a store are found in the STORELANG table.
`forUser`	The logon ID of the user on whose behalf the command will be run. Only a person with the authority to process orders can specify this parameter.
`forUserId`	Same as forUser, but identifying the user by the internal user ID as found in the USERS table.
`storeId`	The reference number of the store for the orders to be listed. If you omit this parameter, the customer's orders for all stores are listed.
`status`	(Required) The status of the orders that are listed.

Output parameters:

None.

Task commands called:

None.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
The 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
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM Copyright notice field.

Constructor Summary

Constructors
Constructor and Description

OrderListCmdImpl()

Constructors
Constructor and Description
`OrderListCmdImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected java.lang.String`	`getStatus()` This method returns the value of the status input parameter.
`void`	`performExecute()` This method executes the business logic of this command implementation.
`void`	`reset()` This method resets instance variables to their initial values.
`void`	`setRequestProperties(TypedProperty aRequestProperties)` This method extracts input parameters from the specified request properties.
`void`	`setStatus(java.lang.String aStatus)` This method specifies the status of the Orders that are to be displayed.
`void`	`setStoreId(java.lang.Integer aStoreId)` This method specifies the identifier of the Store whose Orders are to be displayed.
`void`	`validateParameters()` This method extracts and validates the input parameters of this command implementation.

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 java.lang.Object
clone, equals, finalize, 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.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    The IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OrderListCmdImpl
```
public OrderListCmdImpl()
```
- Method Detail
  - getStatus
```
protected java.lang.String getStatus()
```
    This method returns the value of the status input parameter.
    
    Returns:
    
    A String that specifies the status input parameter.
  - performExecute
```
public void performExecute()
                    throws ECException
```
    This method executes the business logic of this command implementation.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECApplicationException - This exception is thrown if 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()
```
    This method resets instance variables to their initial values.
    
    Specified by:
    
    reset in interface com.ibm.websphere.command.Command
    
    Overrides:
    
    reset in class AbstractECTargetableCommand
  - setRequestProperties
```
public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
```
    This method extracts input parameters from the specified request properties.
    
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class ControllerCommandImpl
    
    Parameters:
    
    aRequestProperties - A TypedProperty that specifies the request properties.
    
    Throws:
    
    ECApplicationException
    
    See Also:
    
    ControllerCommand.setRequestProperties(TypedProperty)
  - setStatus
```
public void setStatus(java.lang.String aStatus)
```
    This method specifies the status of the Orders that are to be displayed.
    
    Specified by:
    
    setStatus in interface OrderListCmd
    
    Parameters:
    
    aStatus - A String that specifies the status of the Orders that are to be displayed.
  - setStoreId
```
public void setStoreId(java.lang.Integer aStoreId)
```
    This method specifies the identifier of the Store whose Orders are to be displayed.
    
    Specified by:
    
    setStoreId in interface OrderListCmd
    
    Parameters:
    
    aStoreId - An Integer that specifies the identifier of the Store whose Orders are to be displayed.
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    This method extracts and validates the input parameters of this command implementation. It checks that the status input parameter is specified, and does not specify "X".
    
    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()

Class OrderListCmdImpl

Behavior:

Input parameters:

Output parameters:

Task commands called:

Field Summary

Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Fields inherited from interface com.ibm.commerce.order.commands.OrderListCmd

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

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

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

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

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

Methods inherited from interface com.ibm.commerce.command.AccCommand

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

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

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

Field Detail

COPYRIGHT

Constructor Detail

OrderListCmdImpl

Method Detail

getStatus

performExecute

reset

setRequestProperties

setStatus

setStoreId

validateParameters