OrderItemMoveCmdImpl

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.orderitems.commands.OrderItemMoveCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, OrderItemMoveCmd, Protectable, 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 OrderItemMoveCmdImpl
extends ControllerCommandImpl
implements OrderItemMoveCmd
```
The OrderItemMove command can be used to move order items from one order to another.
Behavior
OrderItemMove command This command calls the following TaskCommands:
- OrderCopyCmd
- OrderItemUpdateCmd
- SetOrderPaymentInfoCmd
- ResolveOrderItemsCmd
- ResolveOrdersCmd
This command uses the following AccessBeans:
- OrderAccessBean
- OrderItemAccessBean
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.
- Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl
  LOCAL
- Fields inherited from interface com.ibm.commerce.orderitems.commands.OrderItemMoveCmd
  defaultCommandClassName, NAME
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

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

Constructor Summary

Constructors
Constructor and Description

OrderItemMoveCmdImpl()

Constructors
Constructor and Description
`OrderItemMoveCmdImpl()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDoInventory()` This method returns the `doInventory` flag, this flag indicates if the inventory action should be done.
`java.lang.String[]`	`getFromOrderItems()` Gets the input order items.
`java.lang.String[]`	`getFromOrders()` Gets the orders from which order items will be moved.
`java.lang.String[]`	`getInOrderNames()` Gets the names of name-value pairs to be added to the redirection URL.
`java.lang.String[]`	`getOrdersToDeleteIfEmpty()` Gets orders to delete if no order items remain in them after this command completes processing.
`java.lang.String[]`	`getOrdersToDeleteIfNotEmpty()` Deprecated. Replaced by `getOrdersToDeleteIfEmpty()`
`java.lang.String[]`	`getOutOrderItemNames()` Gets the names of name-value pairs to be added to the redirection URL.
`OrderItemAccessBean[]`	`getOutOrderItems()` Gets the output order items.
`java.lang.String[]`	`getOutOrderNames()` Gets the names of name-value pairs to be added to the redirection URL.
`OrderAccessBean[]`	`getOutOrders()` Gets the output orders where input order items are moved to.
`java.lang.String[]`	`getToOrders()` Gets a destination order for the output order items.
`java.lang.String`	`getUrl()` Gets the URL to be redirected to when the command completes successfully.
`void`	`performExecute()` Contains the actual business logic of the command.
`void`	`reset()` This method should be called after a command has been executed to reset its state variables.
`void`	`setContinue(java.lang.String astrContinue)`
`void`	`setDoInventory(java.lang.String doInventory)` This method sets the `doInventory` flag, this flag indicates if the inventory action should be done.
`void`	`setFromOrderItems(java.lang.String[] newFromOrderItems)` Sets the input order items.
`void`	`setFromOrders(java.lang.String[] newFromOrders)` Sets the orders from which order items will be moved.
`void`	`setInOrderNames(java.lang.String[] newInOrderNames)` Sets the names of name-value pairs to be added to the redirection URL.
`void`	`setOrdersToDeleteIfEmpty(java.lang.String[] newOrdersToDeleteIfEmpty)` Sets orders to delete if no order items remain in them after this command completes processing.
`void`	`setOrdersToDeleteIfNotEmpty(java.lang.String[] newOrdersToDeleteIfNotEmpty)` Deprecated. Replaced by `setOrdersToDeleteIfEmpty(java.lang.String[] newOrdersToDeleteIfEmpty)`
`void`	`setOrderToCreateIfEmpty(boolean abOrderToCreateIfEmpty)` Sets the boolean flag to control the creation of an empty output order when there are not order items to move into it.
`void`	`setOutOrderItemNames(java.lang.String[] newOutOrderItemNames)` Sets the names of name-value pairs to be added to the redirection URL.
`void`	`setOutOrderItems(OrderItemAccessBean[] newOutOrderItems)` Sets the output order items.
`void`	`setOutOrderNames(java.lang.String[] newOutOrderNames)` Sets the names of name-value pairs to be added to the redirection URL.
`void`	`setOutOrders(OrderAccessBean[] newOutOrders)` Sets the output orders where input order items are moved to.
`void`	`setRequestProperties(TypedProperty ahshRequestProperties)` The WebController calls this method before invoking the execute method in this command to set the request properties for this command.
`void`	`setToOrders(java.lang.String[] newToOrders)` Sets a destination order for the output order items.
`void`	`setUrl(java.lang.String newUrl)` Sets the URL to be redirected to when the command completes successfully.
`void`	`validateParameters()` Performs server side parameter checking.

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.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, 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
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OrderItemMoveCmdImpl
```
public OrderItemMoveCmdImpl()
```
- Method Detail
  - getFromOrderItems
```
public java.lang.String[] getFromOrderItems()
```
    Gets the input order items.
    
    Returns:
    
    java.lang.String[]
  - getFromOrders
```
public java.lang.String[] getFromOrders()
```
    Gets the orders from which order items will be moved.
    
    Returns:
    
    java.lang.String[]
  - getInOrderNames
```
public java.lang.String[] getInOrderNames()
```
    Gets the names of name-value pairs to be added to the redirection URL.
    
    Returns:
    
    java.lang.String[]
  - getOrdersToDeleteIfEmpty
```
public java.lang.String[] getOrdersToDeleteIfEmpty()
```
    Gets orders to delete if no order items remain in them after this command completes processing.
    
    Returns:
    
    java.lang.String[]
  - getOrdersToDeleteIfNotEmpty
```
public java.lang.String[] getOrdersToDeleteIfNotEmpty()
```
    Deprecated. Replaced by getOrdersToDeleteIfEmpty()
    
    Gets orders to delete if no order items remain in them after this command completes processing.
    
    Returns:
    
    java.lang.String[]
  - getOutOrderItemNames
```
public java.lang.String[] getOutOrderItemNames()
```
    Gets the names of name-value pairs to be added to the redirection URL. The value of each added name-value pair is the reference number of an output order item.
    
    Returns:
    
    java.lang.String[]
  - getOutOrderItems
```
public OrderItemAccessBean[] getOutOrderItems()
```
    Gets the output order items.
    
    Specified by:
    
    getOutOrderItems in interface OrderItemMoveCmd
    
    Returns:
    
    OrderItemAccessBean[]
  - getOutOrderNames
```
public java.lang.String[] getOutOrderNames()
```
    Gets the names of name-value pairs to be added to the redirection URL. The value of each added name-value pair is the reference number of an output order item.
    
    Returns:
    
    java.lang.String[]
  - getOutOrders
```
public OrderAccessBean[] getOutOrders()
```
    Gets the output orders where input order items are moved to.
    
    Specified by:
    
    getOutOrders in interface OrderItemMoveCmd
    
    Returns:
    
    OrderAccessBean[]
  - getToOrders
```
public java.lang.String[] getToOrders()
```
    Gets a destination order for the output order items.
    
    Returns:
    
    java.lang.String[]
  - getUrl
```
public java.lang.String getUrl()
```
    Gets the URL to be redirected to when the command completes successfully.
    
    Returns:
    
    URL
  - performExecute
```
public void performExecute()
                    throws ECException
```
    Contains the actual business logic of the command.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException
  - reset
```
public void reset()
```
    This method should be called after a command has been executed to reset its state variables.
    
    Specified by:
    
    reset in interface com.ibm.websphere.command.Command
    
    Overrides:
    
    reset in class AbstractECTargetableCommand
  - setFromOrderItems
```
public void setFromOrderItems(java.lang.String[] newFromOrderItems)
```
    Sets the input order items. Any order items not in the orders specified by the setFromOrders method are ignored.
    
    Specified by:
    
    setFromOrderItems in interface OrderItemMoveCmd
    
    Parameters:
    
    newFromOrderItems - String[]
  - setFromOrders
```
public void setFromOrders(java.lang.String[] newFromOrders)
```
    Sets the orders from which order items will be moved. This parameter is used to resolve order item abbreviations specified by the setFromOrderItemId method.
    
    Specified by:
    
    setFromOrders in interface OrderItemMoveCmd
    
    Parameters:
    
    newFromOrders - String[]
  - setInOrderNames
```
public void setInOrderNames(java.lang.String[] newInOrderNames)
```
    Sets the names of name-value pairs to be added to the redirection URL. The value of each added name-value pair is the reference number of an output order.
    
    Specified by:
    
    setInOrderNames in interface OrderItemMoveCmd
    
    Parameters:
    
    newInOrderNames - String[]
  - setOrdersToDeleteIfEmpty
```
public void setOrdersToDeleteIfEmpty(java.lang.String[] newOrdersToDeleteIfEmpty)
```
    Sets orders to delete if no order items remain in them after this command completes processing.
    
    Specified by:
    
    setOrdersToDeleteIfEmpty in interface OrderItemMoveCmd
    
    Parameters:
    
    newOrdersToDeleteIfEmpty - String[]
  - setOrdersToDeleteIfNotEmpty
```
public void setOrdersToDeleteIfNotEmpty(java.lang.String[] newOrdersToDeleteIfNotEmpty)
```
    Deprecated. Replaced by setOrdersToDeleteIfEmpty(java.lang.String[] newOrdersToDeleteIfEmpty)
    
    Sets orders to delete if no order items remain in them after this command completes processing.
    
    Parameters:
    
    newOrdersToDeleteIfNotEmpty - String[]
  - setOrderToCreateIfEmpty
```
public void setOrderToCreateIfEmpty(boolean abOrderToCreateIfEmpty)
```
    Sets the boolean flag to control the creation of an empty output order when there are not order items to move into it.
    
    Specified by:
    
    setOrderToCreateIfEmpty in interface OrderItemMoveCmd
    
    Parameters:
    
    abOrderToCreateIfEmpty - boolean
  - setOutOrderItemNames
```
public void setOutOrderItemNames(java.lang.String[] newOutOrderItemNames)
```
    Sets the names of name-value pairs to be added to the redirection URL. The value of each added name-value pair is the reference number of an output order item.
    
    Specified by:
    
    setOutOrderItemNames in interface OrderItemMoveCmd
    
    Parameters:
    
    newOutOrderItemNames - String[]
  - setOutOrderItems
```
public void setOutOrderItems(OrderItemAccessBean[] newOutOrderItems)
```
    Sets the output order items.
    
    Parameters:
    
    newOutOrderItems - OrderItemAccessBean[]
  - setOutOrderNames
```
public void setOutOrderNames(java.lang.String[] newOutOrderNames)
```
    Sets the names of name-value pairs to be added to the redirection URL. The value of each added name-value pair is the reference number of an output order.
    
    Specified by:
    
    setOutOrderNames in interface OrderItemMoveCmd
    
    Parameters:
    
    newOutOrderNames - String[]
  - setOutOrders
```
public void setOutOrders(OrderAccessBean[] newOutOrders)
```
    Sets the output orders where input order items are moved to.
    
    Parameters:
    
    newOutOrders - OrderAccessBean[]
  - setRequestProperties
```
public void setRequestProperties(TypedProperty ahshRequestProperties)
                          throws ECApplicationException
```
    The WebController calls this method before invoking the execute method in this command to set the request properties for this command.
    
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class ControllerCommandImpl
    
    Parameters:
    
    ahshRequestProperties - request properties
    
    Throws:
    
    ECApplicationException
  - setToOrders
```
public void setToOrders(java.lang.String[] newToOrders)
```
    Sets a destination order for the output order items. If this parameter is not specified, it means there is no output order. And the input order items will be simply removed from the source orders specified by the setFromOrders method.
    
    Specified by:
    
    setToOrders in interface OrderItemMoveCmd
    
    Parameters:
    
    newToOrders - String[]
  - setUrl
```
public void setUrl(java.lang.String newUrl)
```
    Sets the URL to be redirected to when the command completes successfully.
    
    Specified by:
    
    setUrl in interface OrderItemMoveCmd
    
    Parameters:
    
    newUrl - String
  - setDoInventory
```
public void setDoInventory(java.lang.String doInventory)
```
    This method sets the doInventory flag, this flag indicates if the inventory action should be done. "Y" indicates that the inventory action should be done. "N" indicates that the inventory action should not be done.
    
    Parameters:
    
    doInventory -
  - getDoInventory
```
public java.lang.String getDoInventory()
```
    This method returns the doInventory flag, this flag indicates if the inventory action should be done. "Y" indicates that the inventory action should be done. "N" indicates that the inventory action should not be done.
    
    Returns:
    
    The value of the flag.
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    Performs server side parameter checking.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AbstractECTargetableCommand
    
    Throws:
    
    ECException
  - setContinue
```
public void setContinue(java.lang.String astrContinue)
```
    Parameters:
    
    astrContinue - the continue parameter.

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

Fields inherited from interface com.ibm.commerce.orderitems.commands.OrderItemMoveCmd

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

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

OrderItemMoveCmdImpl

getFromOrderItems

getFromOrders

getInOrderNames

getOrdersToDeleteIfEmpty

getOrdersToDeleteIfNotEmpty

getOutOrderItemNames

getOutOrderItems

getOutOrderNames

getOutOrders

getToOrders

getUrl

performExecute

reset

setFromOrderItems

setFromOrders

setInOrderNames

setOrdersToDeleteIfEmpty

setOrdersToDeleteIfNotEmpty

setOrderToCreateIfEmpty

setOutOrderItemNames

setOutOrderItems

setOutOrderNames

setOutOrders

setRequestProperties

setToOrders

setUrl

setDoInventory

getDoInventory

validateParameters

setContinue