public class SSFSOrderCopyCmdImpl extends ControllerCommandImpl implements SSFSOrderCopyCmd
OrderCopy
controller command. It first invokes Sterling OMS API getCompleteOrderDetails
to get a remote order detail information and then create or update the local destination order with that information.
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 log on 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 |
Sets the store ID of the destination order. It is also used to resolve special abbreviations.
(".", "*", ".t", ".**.", and "*t") when they appear in fromOrderId_i , toOrderId , orderInfoFrom ,
and payInfoFrom. For example, the following command refers to all pending orders of member 1001 in store 1:
fromOrderId_1=*&memberId_1=1001&storeId=1. |
URL |
Mandatory, the redirection URL that is called when the command successfully completes. |
outOrderItemName |
Specifies 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 a destination order item. The default value is "orderItemId". This parameter can be repeated. |
outOrderName |
Specifies 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 a destination order. The default value is "orderId". This parameter can be repeated. |
toOrderId |
Specifies the order to be created or modified. It can be specified as an order reference number or as one of the special abbreviations ".", "*", ".t", "*t", "**" and ".**.". If it is not specified, it defaults to "**", which creates a new order. If more than one order is specified, it is as if only the most recently updated one was specified. Abbreviations are resolved using the current customer (the customer running this command) and the store specified in the storeId parameter. |
ShipAsComplete |
Specifies the ShipAsComplete flag of the destination order. |
prepare |
Controls whether the destination order will be prepared by OrderPrepare command or not. |
calculate |
Controls whether the destination order will be calculated by OrderCalculate command or not. |
copyAutoAddedOrderItems |
Controls whether the auto added order items to be copied from source order to destination order. |
sensitiveInfoCopy |
Controls whether the sensitive information to be copied from the source order to the destination order. |
copyOrderPromotionCode |
Controls whether the order public promotion code to be copied from the source order to the destination order. Default is 'N' which means not to copy promotion codes. |
copyOrderUniquePromotionCode |
Controls whether the order unique promotion code to be copied from the source order to the destination order. Default is 'N' which means not to copy unique promotion codes. |
OrderHeaderKey |
Specifies remote order's unique identifier. |
OrderNo |
Specifies remote order's order number. |
Name | Description |
---|---|
the value of the outOrderId |
the order Id of the output orders. |
the value of the outOrderItemId |
the orderItem Id of the output orderItems. |
PrepareOrderCmd
task command if istrPrepare
is "Y".CalculateOrderCmd
task command if istrCalculate
is "Y".viewTaskName
response property to "RedirectView".ResolveOrdersCmd
ResolveOrderItemsCmd
SetPendingOrderCmd
OrderItemUpdateCmd
PrepareShipInfoCmd
PrepareOrderCmd
CalculateOrderCmd
ComposeSSFSOrderDataCmd
OrderAccessBean
AddressAccessBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM Copyright notice field.
|
static java.lang.String |
EC_CALCULATE
The string of order calculate.
|
static java.lang.String |
EC_PREPARE
The string of order prepare.
|
static java.lang.String |
EC_SHIPASCOMPLETE
The string of ship as complete.
|
defaultCommandClassName, NAME
Constructor and Description |
---|
SSFSOrderCopyCmdImpl() |
Modifier and Type | Method and Description |
---|---|
java.util.Vector |
getItemsToBeRemoved()
To Retrieve items to be removed after copy.
|
void |
performExecute()
Executes the main business logic of the command.
|
void |
reset()
Resets instance variables to their initial values.
|
void |
setCalculate(java.lang.String astrCalculate)
Set if the order should be calculated.
|
void |
setCopyAutoAddedOrderItemsFlag(boolean abCopyAutoAddedOrderItemsFlag)
Set the flag which decides whether to copy auto added order item.
|
void |
setOrderHeaderKey(java.lang.String astrFromOrderHeaderKey)
Set the unique key of the order.
|
void |
setOrderNo(java.lang.String astrFromOrderNo)
Set the order number of the order.
|
void |
setOrderPromotionCodeCopyFlag(java.lang.String astrOrderPromotionCodeCopyFlag)
Set the order promotion code copy flag.
|
void |
setOrderUniquePromotionCodeCopyFlag(java.lang.String astrOrderUniquePromotionCodeCopyFlag)
Set the order unique promotion codes copy flag.
|
void |
setOutOrderItemNames(java.lang.String[] astrOutOrderItemNames)
Sets the names of the orderItemId properties to be appended to the redirection URL.
|
void |
setOutOrderNames(java.lang.String[] astrOutOrderNames)
Sets the names of the orderId properties to be appended to the redirection URL.
|
void |
setPrepare(java.lang.String astrPrepare)
Set if the order should be Prepared.
|
void |
setRequestProperties(TypedProperty ahshRequestProperties)
Extracts input parameters from the specified request properties.
|
void |
setSensitiveInfoCopyFlag(java.lang.String astrSensitiveInfoCopyFlag)
Set the flag which decides whether to copy sensitive (payment and so forth) info or not.
|
void |
setShipAsComplete(java.lang.String astrShipAsComplete)
Set if the order should be set as ShipAsComplete.
|
void |
setToOrderAbbreviations(java.lang.String[] astrToOrderAbbreviations)
Set the target order.
|
void |
validateParameters()
Validates the input parameters.
|
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache
getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
fulfills, getOwner
public static final java.lang.String COPYRIGHT
public static final java.lang.String EC_SHIPASCOMPLETE
public static final java.lang.String EC_PREPARE
public static final java.lang.String EC_CALCULATE
public void reset()
reset
in interface com.ibm.websphere.command.Command
reset
in class AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface ECCommand
performExecute
in interface com.ibm.websphere.command.TargetableCommand
performExecute
in class AbstractECTargetableCommand
ECException
ECCommand#performExecute()
public java.util.Vector getItemsToBeRemoved()
getItemsToBeRemoved
in interface SSFSOrderCopyCmd
public void validateParameters() throws ECException
ResolveOrdersCmd
task command to resolve Order abbreviations.ResolveOrderItemsCmd
task command to resolve OrderItem abbreviations.CheckOrderCopyCmd
task command for each of the Orders to be accessed.validateParameters
in interface ECCommand
validateParameters
in class AbstractECTargetableCommand
ECException
ECCommand#validateParameters()
public void setRequestProperties(TypedProperty ahshRequestProperties) throws ECApplicationException
setRequestProperties
in interface ControllerCommand
setRequestProperties
in class ControllerCommandImpl
ahshRequestProperties
- The request properties.
ECApplicationException
ControllerCommand#setRequestProperties(TypedProperty)
public void setShipAsComplete(java.lang.String astrShipAsComplete)
setShipAsComplete
in interface SSFSOrderCopyCmd
astrShipAsComplete
- The value can be ("Y") or ("N"). Default is ("Y").public void setPrepare(java.lang.String astrPrepare)
setPrepare
in interface SSFSOrderCopyCmd
astrPrepare
- The value can be ("Y") or ("N"). Default is ("N").public void setCalculate(java.lang.String astrCalculate)
setCalculate
in interface SSFSOrderCopyCmd
astrCalculate
- The value can be "0" (not for calculation) or "1" (Default: for calculation).public void setCopyAutoAddedOrderItemsFlag(boolean abCopyAutoAddedOrderItemsFlag)
setCopyAutoAddedOrderItemsFlag
in interface SSFSOrderCopyCmd
abCopyAutoAddedOrderItemsFlag
- public void setSensitiveInfoCopyFlag(java.lang.String astrSensitiveInfoCopyFlag)
setSensitiveInfoCopyFlag
in interface SSFSOrderCopyCmd
astrSensitiveInfoCopyFlag
- The sensitive information copy flag.public void setOrderPromotionCodeCopyFlag(java.lang.String astrOrderPromotionCodeCopyFlag)
setOrderPromotionCodeCopyFlag
in interface SSFSOrderCopyCmd
astrOrderPromotionCodeCopyFlag
- The order promotion code copy flag.public void setOrderUniquePromotionCodeCopyFlag(java.lang.String astrOrderUniquePromotionCodeCopyFlag)
setOrderUniquePromotionCodeCopyFlag
in interface SSFSOrderCopyCmd
astrOrderUniquePromotionCodeCopyFlag
- The order unique promotion code copy flag.public void setOutOrderItemNames(java.lang.String[] astrOutOrderItemNames)
setOutOrderItemNames
in interface SSFSOrderCopyCmd
astrOutOrderItemNames
- The names of the orderItemId properties.public void setOutOrderNames(java.lang.String[] astrOutOrderNames)
setOutOrderNames
in interface SSFSOrderCopyCmd
astrOutOrderNames
- The names of the orderId properties.public void setToOrderAbbreviations(java.lang.String[] astrToOrderAbbreviations)
setToOrderAbbreviations
in interface SSFSOrderCopyCmd
astrToOrderAbbreviations
- The target order.public void setOrderHeaderKey(java.lang.String astrFromOrderHeaderKey)
setOrderHeaderKey
in interface SSFSOrderCopyCmd
astrFromOrderHeaderKey
- The unique key of the order.public void setOrderNo(java.lang.String astrFromOrderNo)
setOrderNo
in interface SSFSOrderCopyCmd
astrFromOrderNo
- The order number of the order.