com.ibm.commerce.orderitems.commands
Interface OrderItemMoveCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable
All Known Implementing Classes:
OrderItemMoveCmdImpl

public interface OrderItemMoveCmd
extends ControllerCommand

The OrderItemMove command can be used to move order items from one order to another.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 OrderItemAccessBean[] getOutOrderItems()
          Gets the output order items.
 OrderAccessBean[] getOutOrders()
          Gets the output order where input order items are moved to.
 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 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 setOutOrderNames(java.lang.String[] newOutOrderNames)
          Sets the names of name-value pairs to be added to the redirection URL.
 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.
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName

NAME

public static final java.lang.String NAME
Method Detail

getOutOrderItems

public OrderItemAccessBean[] getOutOrderItems()
Gets the output order items.

getOutOrders

public OrderAccessBean[] getOutOrders()
Gets the output order where input order items are moved to.

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.

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.

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.

setOrdersToDeleteIfEmpty

public void setOrdersToDeleteIfEmpty(java.lang.String[] newOrdersToDeleteIfEmpty)
Sets orders to delete if no order items remain in them after this command completes processing.

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.

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.

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.

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.

setUrl

public void setUrl(java.lang.String newUrl)
Sets the URL to be redirected to when the command completes successfully.