com.ibm.commerce.orderitems.commands
Interface OrderItemMoveCmd
-
- All Superinterfaces:
- AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand
- 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
Fields Modifier and Type Field and Description static java.lang.String
COPYRIGHT
IBM copyright notice field.static java.lang.String
defaultCommandClassName
The default implementation class.static java.lang.String
NAME
The name of the Command Interface class.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description OrderItemAccessBean[]
getOutOrderItems()
Gets the output order items.OrderAccessBean[]
getOutOrders()
Gets the output orders 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
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, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties
-
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, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
-
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
-
-
-
-
Field Detail
-
COPYRIGHT
static final java.lang.String COPYRIGHT
IBM copyright notice field.- See Also:
- Constant Field Values
-
NAME
static final java.lang.String NAME
The name of the Command Interface class.- See Also:
- Constant Field Values
-
defaultCommandClassName
static final java.lang.String defaultCommandClassName
The default implementation class.- See Also:
- Constant Field Values
-
-
Method Detail
-
getOutOrderItems
OrderItemAccessBean[] getOutOrderItems()
Gets the output order items.- Returns:
- OrderItemAccessBean[]
-
getOutOrders
OrderAccessBean[] getOutOrders()
Gets the output orders where input order items are moved to.- Returns:
- OrderAccessBean[]
-
setFromOrderItems
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.- Parameters:
newFromOrderItems
- String[]
-
setFromOrders
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.- Parameters:
newFromOrders
- String[]
-
setInOrderNames
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.- Parameters:
newInOrderNames
- String[]
-
setOrdersToDeleteIfEmpty
void setOrdersToDeleteIfEmpty(java.lang.String[] newOrdersToDeleteIfEmpty)
Sets orders to delete if no order items remain in them after this command completes processing.- Parameters:
newOrdersToDeleteIfEmpty
- String[]
-
setOrderToCreateIfEmpty
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.- Parameters:
abOrderToCreateIfEmpty
- boolean
-
setOutOrderItemNames
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.- Parameters:
newOutOrderItemNames
- String[]
-
setOutOrderNames
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.- Parameters:
newOutOrderNames
- String[]
-
setToOrders
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.- Parameters:
newToOrders
- String[]
-
setUrl
void setUrl(java.lang.String newUrl)
Sets the URL to be redirected to when the command completes successfully.- Parameters:
newUrl
- URL.
-
-