public class SSFSOrderCopyCmdImpl extends ControllerCommandImpl implements SSFSOrderCopyCmd
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. |
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.
|
Constructor and Description |
---|
SSFSOrderCopyCmdImpl() |
Modifier and Type | Method and Description |
---|---|
protected void | calculateOrder()
This method calculates copy-to order.
|
protected void | copyAddressId()
Copy Address Id
|
protected void | copyBuschnId()
Copy BuschnId
|
protected void | copyComment()
Copy comment
|
protected void | copyDescription()
Copy Description
|
protected void | copyField1()
Copy Field1
|
protected void | copyField2()
Copy Field2
|
protected void | copyField3()
Copy Field3
|
protected void | copyOrderInfo()
If a new Order is to be created, create it and set its status to P.
|
protected void | copyOrderItemsInfo()
This method is used to copy order items level information according to the order line information retrieved from Sterling OMS.
|
protected void | copyPaymentInstructions(com.ibm.commerce.order.sterling.utils.SSFSOrderData orderData, java.lang.Long toOrderId)
Copy the order payment info from the order.
|
protected void | copyPublicPromotionCode(com.ibm.commerce.order.sterling.utils.SSFSOrderData orderData, java.lang.Long toOrderId)
This method copies public promotion codes from source orders to the target order.
|
protected void | copySequence()
Copy Sequence
|
protected void | copyShipInfo()
This method is used to copy ship info for order ship mode level and OrderItem level.
|
protected void | copyUniquePromotionCode(com.ibm.commerce.order.sterling.utils.SSFSOrderData orderData, java.lang.Long toOrderId)
This method copies unique promotion codes from source orders to the target order.
|
protected org.w3c.dom.Document | getCompleteOrderDetails()
Call SC getCompleteOrderDetails to get the detail information of an order.
|
protected ComposeSSFSOrderDataCmd | getComposeSSFSOrderDataCmd()
Get the ComposeSSFSOrderDataCmd to be used by SSFSOrderCopyCmdImpl.
|
protected java.util.Map | getInputParametersMap()
Build the input parameter map for getCompleteOrderDetails.
|
java.util.Vector | getItemsToBeRemoved()
To Retrieve items to be removed after copy.
|
protected OrderItemUpdateCmd | getOrderItemUpdateCmd()
Get the OrderItemUpdateCmd to be used by OrderCopyCmdImpl.
|
protected void | initCopyOrderInfoFrom()
First Call Sterling getCompleteOrderDetails API to get the order info, then compose SSFSOrderData with the response.
|
protected boolean | isCopyAutoAddedOrderItems()
This method returns a boolean value to indicate whether to copy automatically added order items.
|
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.
|
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()
public void performExecute() throws ECException
protected void copyOrderInfo() throws ECException
protected void copyComment()
protected void copyField3()
protected void copySequence()
protected void copyDescription()
protected void copyField2()
protected void copyField1()
protected void copyAddressId()
protected void copyBuschnId()
protected void copyOrderItemsInfo() throws ECException
protected void copyShipInfo() throws ECException
protected OrderItemUpdateCmd getOrderItemUpdateCmd() throws ECException
public java.util.Vector getItemsToBeRemoved()
public void validateParameters() throws ECException
protected void calculateOrder() throws ECException
public void setRequestProperties(TypedProperty ahshRequestProperties) throws ECApplicationException
public void setShipAsComplete(java.lang.String astrShipAsComplete)
public void setPrepare(java.lang.String astrPrepare)
public void setCalculate(java.lang.String astrCalculate)
protected void initCopyOrderInfoFrom() throws ECException
protected ComposeSSFSOrderDataCmd getComposeSSFSOrderDataCmd() throws ECException
protected org.w3c.dom.Document getCompleteOrderDetails() throws ECException
protected java.util.Map getInputParametersMap()
protected void copyPaymentInstructions(com.ibm.commerce.order.sterling.utils.SSFSOrderData orderData, java.lang.Long toOrderId) throws ECException
protected void copyPublicPromotionCode(com.ibm.commerce.order.sterling.utils.SSFSOrderData orderData, java.lang.Long toOrderId) throws ECException
protected void copyUniquePromotionCode(com.ibm.commerce.order.sterling.utils.SSFSOrderData orderData, java.lang.Long toOrderId) throws ECException
protected boolean isCopyAutoAddedOrderItems()
public void setCopyAutoAddedOrderItemsFlag(boolean abCopyAutoAddedOrderItemsFlag)
public void setSensitiveInfoCopyFlag(java.lang.String astrSensitiveInfoCopyFlag)
public void setOrderPromotionCodeCopyFlag(java.lang.String astrOrderPromotionCodeCopyFlag)
public void setOrderUniquePromotionCodeCopyFlag(java.lang.String astrOrderUniquePromotionCodeCopyFlag)
public void setOutOrderItemNames(java.lang.String[] astrOutOrderItemNames)
public void setOutOrderNames(java.lang.String[] astrOutOrderNames)
public void setToOrderAbbreviations(java.lang.String[] astrToOrderAbbreviations)
public void setOrderHeaderKey(java.lang.String astrFromOrderHeaderKey)
public void setOrderNo(java.lang.String astrFromOrderNo)