CSROrderProcessCmdImpl

java.lang.Object
- com.ibm.websphere.command.TargetableCommandImpl
- - com.ibm.websphere.command.CacheableCommandImpl
  - - com.ibm.commerce.command.MeasuredCacheableCommandImpl
    - - com.ibm.commerce.command.AbstractECTargetableCommand
      - com.ibm.commerce.command.ControllerCommandImpl
        
        com.ibm.commerce.tools.command.ToolsControllerCommandImpl
        
        com.ibm.commerce.tools.optools.order.commands.CSRBaseControllerCommandImpl
        
        com.ibm.commerce.tools.optools.order.commands.CSROrderProcessCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, ToolsControllerCommand, CSROrderProcessCmd, com.ibm.websphere.cache.Sizeable, 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 CSROrderProcessCmdImpl
extends CSRBaseControllerCommandImpl
implements CSROrderProcessCmd
```
This is the default implementation of the CSROrderProcessCmd command.
This command calls the following Commands:
This command uses the following AccessBeans:
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.
`static java.lang.String`	`NOTEBOOK_URL` The return url for a notebook widget.
`static java.lang.String`	`WIZARD_URL` The return url for a wizard widget.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl
LOCAL

Fields inherited from interface com.ibm.commerce.tools.optools.order.commands.CSROrderProcessCmd
defaultCommandClassName, NAME

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

Constructor Summary

Constructors
Constructor and Description

CSROrderProcessCmdImpl()

Constructors
Constructor and Description
`CSROrderProcessCmdImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAdminId()` Returns the administrator's ID.
`java.lang.String`	`getBackupOrderId()` Returns backup order ID.
`java.util.Hashtable`	`getComment()` Returns comment as a Hashtable.
`java.lang.String`	`getCustomerId()` Returns customer ID.
`java.lang.String`	`getEditOrderInfo()` Returns "true" if it is called from an edit order notebook.
`java.lang.String`	`getFirstBillingAddressId()` Returns first billing address ID.
`java.lang.String`	`getFirstDirtyBit()` Returns the first order dirty status.
`java.lang.String`	`getFirstOrderId()` Returns first order ID.
`java.util.Hashtable`	`getFirstPayment()` Returns the payment information for the first order as a Hashtable.
`java.util.Hashtable`	`getNLS()` Returns the properties containing all translatable messages for this command.
`java.lang.String`	`getNotifyMerchant()` Gets notify merchant option.
`java.lang.String`	`getNotifyOrderSubmitted()` Gets order submitted notification option.
`java.lang.String`	`getNotifyShopper()` Gets notify customer option.
`CommandContext`	`getOrgCmdContext()` Returns the original commandContext (administrator's command context).
`java.lang.Integer`	`getOrgLangId()` Returns original language ID.
`java.util.Locale`	`getOrgLocale()` Returns original locale.
`TypedProperty`	`getOrgReqProperties()` Returns original request properties.
`java.lang.String`	`getPoNumber()` Get the PO number
`java.lang.String`	`getRedirectURL()` Returns the redirect URL that is to be executed after this controller command terminates.
`AccessVector`	`getResources()` Gets the access vector accessed by this command.
`java.lang.String`	`getSecondBillingAddressId()` Returns second billing address ID.
`java.lang.String`	`getSecondOrderId()` Returns second order ID.
`java.util.Hashtable`	`getSecondPayment()` Returns the payment information for the second order as a Hashtable.
`java.lang.String`	`getXMLFile()` Returns XML file.
`boolean`	`isBackupOrderDeleteError()` Returns error flag for deleting backup order error.
`boolean`	`isEmailError()` Returns error flag for email comment error.
`boolean`	`isFirstOrderExist()` Returns true if the first order exits.
`boolean`	`isSecondOrderExist()` Returns true if the Second order exits.
`void`	`performExecute()` This method performs the execution for process the new order(s) and cancel old order if necessary.
`void`	`reset()` This method should be called after a command has been executed to reset its states variables.
`void`	`setNotifyMerchant(java.lang.String notifyMerchant)` Sets notify merchant option.
`void`	`setNotifyOrderSubmitted(java.lang.String notifyOrderSubmitted)` Sets order submitted notification option.
`void`	`setNotifyShopper(java.lang.String notifyShopper)` Sets notify customer option.
`void`	`setPoNumber(java.lang.String string)` Set the PO number
`void`	`validateParameters()` This method gets XMLObject from the GUI Notebook or Wizard and get ready to parse it.

Methods inherited from class com.ibm.commerce.tools.optools.order.commands.CSRBaseControllerCommandImpl
getIfExePreCmdChains, getPreCmdChain, setIfExePreCmdChains, setPreCmdChain

Methods inherited from class com.ibm.commerce.tools.command.ToolsControllerCommandImpl
getViewInputProperties, setRequestProperties

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl
getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object
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, setRequestProperties, 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, 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
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - NOTEBOOK_URL
```
public static final java.lang.String NOTEBOOK_URL
```
    The return url for a notebook widget.
    
    See Also:
    
    Constant Field Values
  - WIZARD_URL
```
public static final java.lang.String WIZARD_URL
```
    The return url for a wizard widget.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CSROrderProcessCmdImpl
```
public CSROrderProcessCmdImpl()
```
- Method Detail
  - getAdminId
```
public java.lang.String getAdminId()
```
    Returns the administrator's ID.
    
    Returns:
    
    The administrator's ID that is performing the action on behalf of the customer.
  - getBackupOrderId
```
public java.lang.String getBackupOrderId()
```
    Returns backup order ID.
    
    Returns:
    
    The backup order ID created for this order.
  - getComment
```
public java.util.Hashtable getComment()
```
    Returns comment as a Hashtable.
    
    Returns:
    
    The comment name-value pair with the comment details.
  - getCustomerId
```
public java.lang.String getCustomerId()
```
    Returns customer ID.
    
    Returns:
    
    The customer's ID.
  - getEditOrderInfo
```
public java.lang.String getEditOrderInfo()
```
    Returns "true" if it is called from an edit order notebook.
    
    Returns:
    
    "true" if it is called from an edit order notebook; "false" otherwise.
  - getFirstBillingAddressId
```
public java.lang.String getFirstBillingAddressId()
```
    Returns first billing address ID.
    
    Returns:
    
    The billing address ID for the first order.
  - getFirstDirtyBit
```
public java.lang.String getFirstDirtyBit()
```
    Returns the first order dirty status.
    
    Returns:
    
    Return String "true" if there are some adjustments for the first order, "false" if not.
  - getFirstOrderId
```
public java.lang.String getFirstOrderId()
```
    Returns first order ID.
    
    Returns:
    
    The order ID of the first order.
  - getFirstPayment
```
public java.util.Hashtable getFirstPayment()
```
    Returns the payment information for the first order as a Hashtable.
    
    Returns:
    
    The name-value pairs containing the payment information for the first order.
  - getNLS
```
public java.util.Hashtable getNLS()
```
    Returns the properties containing all translatable messages for this command.
    
    Returns:
    
    Name value pairs of translatable messages.
  - getOrgCmdContext
```
public CommandContext getOrgCmdContext()
```
    Returns the original commandContext (administrator's command context).
    
    Returns:
    
    The original command context when calling this command.
  - getOrgLangId
```
public java.lang.Integer getOrgLangId()
```
    Returns original language ID.
    
    Returns:
    
    The original language ID.
  - getOrgLocale
```
public java.util.Locale getOrgLocale()
```
    Returns original locale.
    
    Returns:
    
    The original locale.
  - getOrgReqProperties
```
public TypedProperty getOrgReqProperties()
```
    Returns original request properties.
    
    Returns:
    
    The original request properties.
  - getRedirectURL
```
public java.lang.String getRedirectURL()
```
    Returns the redirect URL that is to be executed after this controller command terminates.
    
    Returns:
    
    The name of the view to be redirected to.
  - getResources
```
public AccessVector getResources()
                          throws ECException
```
    Gets the access vector accessed by this command. The default implementation returns null indicating that no protectable resource is accessed by this command.
    
    Specified by:
    
    getResources in interface ECCommand
    
    Overrides:
    
    getResources in class AbstractECTargetableCommand
    
    Returns:
    
    The vector of resource action pairs
    
    Throws:
    
    ECException - If the resource can not be retrieved.
  - getSecondBillingAddressId
```
public java.lang.String getSecondBillingAddressId()
```
    Returns second billing address ID.
    
    Returns:
    
    The billing address ID for the second order.
  - getSecondOrderId
```
public java.lang.String getSecondOrderId()
```
    Returns second order ID.
    
    Returns:
    
    The order ID of the second order.
  - getSecondPayment
```
public java.util.Hashtable getSecondPayment()
```
    Returns the payment information for the second order as a Hashtable.
    
    Returns:
    
    The name-value pairs containing the payment information for the second order.
  - getXMLFile
```
public java.lang.String getXMLFile()
```
    Returns XML file.
    
    Returns:
    
    The entire XML file.
  - isBackupOrderDeleteError
```
public boolean isBackupOrderDeleteError()
```
    Returns error flag for deleting backup order error.
    
    Returns:
    
    true if there is an error to delete a backup order.
  - isEmailError
```
public boolean isEmailError()
```
    Returns error flag for email comment error.
    
    Returns:
    
    true if there is an email error.
  - isFirstOrderExist
```
public boolean isFirstOrderExist()
```
    Returns true if the first order exits.
    
    Returns:
    
    Return true if the first order exists (that is has order items).
  - isSecondOrderExist
```
public boolean isSecondOrderExist()
```
    Returns true if the Second order exits.
    
    Returns:
    
    Return true if the second order exists (that is has order items).
  - performExecute
```
public void performExecute()
                    throws ECException
```
    This method performs the execution for process the new order(s) and cancel old order if necessary.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException - if unable to process the orders.
  - validateParameters
```
public void validateParameters()
                        throws ECApplicationException
```
    This method gets XMLObject from the GUI Notebook or Wizard and get ready to parse it. It also gets the success redirect URL.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class CSRBaseControllerCommandImpl
    
    Throws:
    
    ECException - If the XMLObject cannot be parsed, throw ECApplicationException
    
    ECApplicationException
  - getNotifyMerchant
```
public java.lang.String getNotifyMerchant()
```
    Gets notify merchant option.
    
    Returns:
    
    notify merchant option.
  - setNotifyMerchant
```
public void setNotifyMerchant(java.lang.String notifyMerchant)
```
    Sets notify merchant option.
    
    Parameters:
    
    notifyMerchant - "1" to notify merchant; "0" not to notify merchant.
  - getNotifyShopper
```
public java.lang.String getNotifyShopper()
```
    Gets notify customer option.
    
    Returns:
    
    notify shopper option.
  - setNotifyShopper
```
public void setNotifyShopper(java.lang.String notifyShopper)
```
    Sets notify customer option.
    
    Parameters:
    
    notifyShopper - "1" to notify customer; "0" not to notify customer.
  - getNotifyOrderSubmitted
```
public java.lang.String getNotifyOrderSubmitted()
```
    Gets order submitted notification option.
    
    Returns:
    
    Returns a java.lang.String
  - setNotifyOrderSubmitted
```
public void setNotifyOrderSubmitted(java.lang.String notifyOrderSubmitted)
```
    Sets order submitted notification option.
    
    Parameters:
    
    notifyOrderSubmitted - "1" to notify order submission; "0" not to notify order submission.
  - getPoNumber
```
public java.lang.String getPoNumber()
```
    Get the PO number
    
    Returns:
    
    PO number
  - setPoNumber
```
public void setPoNumber(java.lang.String string)
```
    Set the PO number
    
    Parameters:
    
    string - PO number
  - reset
```
public void reset()
```
    This method should be called after a command has been executed to reset its states variables.
    
    Specified by:
    
    reset in interface com.ibm.websphere.command.Command
    
    Overrides:
    
    reset in class AbstractECTargetableCommand

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

Fields inherited from interface com.ibm.commerce.tools.optools.order.commands.CSROrderProcessCmd

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

Methods inherited from class com.ibm.commerce.tools.optools.order.commands.CSRBaseControllerCommandImpl

Methods inherited from class com.ibm.commerce.tools.command.ToolsControllerCommandImpl

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

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

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

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

COPYRIGHT

NOTEBOOK_URL

WIZARD_URL

CSROrderProcessCmdImpl

getAdminId

getBackupOrderId

getComment

getCustomerId

getEditOrderInfo

getFirstBillingAddressId

getFirstDirtyBit

getFirstOrderId

getFirstPayment

getNLS

getOrgCmdContext

getOrgLangId

getOrgLocale

getOrgReqProperties

getRedirectURL

getResources

getSecondBillingAddressId

getSecondOrderId

getSecondPayment

getXMLFile

isBackupOrderDeleteError

isEmailError

isFirstOrderExist

isSecondOrderExist

performExecute

validateParameters

getNotifyMerchant

setNotifyMerchant

getNotifyShopper

setNotifyShopper

getNotifyOrderSubmitted

setNotifyOrderSubmitted

getPoNumber

setPoNumber

reset