public class OrderProcessCmdImpl extends OrderBaseCmdImpl implements OrderProcessCmd
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 logon 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 | The reference number of the store with which the order is to be placed. This value is ignored unless an error occurs before the order is resolved. It is used only to call the correct store's exception handler. |
orderId | The reference number of the order to be processed. This parameter can be repeated. |
billtoAddressId | The reference number of the address to bill. |
field1 | Customizable field1. |
field2 | Customizable field2. |
field3 | Customizable field3. |
notifyMerchant | Whether the store is notified when the order processing is complete. E-mail notifications are only sent when WebSphere Commerce is configured with WebSphere Commerce Payments. 1=Yes ,0=No |
notifyShopper | Whether the customer is notified when the order processing is complete. E-mail notifications are only sent when WebSphere Commerce is configured with WebSphere Commerce Payments. 1=Yes, 0=No |
notifyOrderSubmitted | Specifies whether the customer is notified when the order is successfully submitted for processing. 1=Yes0=No (default) |
quoteExpiryPolicy | Defines the behavior of the command if the order total expires or an order item's fulfillment center changes during inventory allocation. Order total expires if the current time is greater than or equal to the result of: the order last update timestamp plus the number of seconds specified in the QUOTEGOODFOR column of the STORE table. This parameter may have three values: alwaysProceed - Always proceed with processing the order after recalculating order total. stopOnBiggerTotal - Proceed with processing the order if the recalculated order total is unchanged or less than the previous order total. Otherwise, redirect to a URL specified by the quoteExpiredUrl. neverProceed - Always redirect to the URL specified by the quoteExpiredUrl parameter. |
quoteExpiredURL | Specifies the URL to which to redirect if the order total expired in agreement with the expiry policy specified by the quoteExpiryPolicy parameter. |
availabilityChangeURL | Specifies the URL to redirect to. The estimated availability time plus the shipping offset for any order item moves into the future (as a result of allocating or backordering inventory). If the result is more than the time interval specified by the maxAvailabilityChange parameter, redirect to the specified URL. This parameter is ignored if ATP inventory allocation is not enabled. |
maxAvailabilityChange | Specifies the time interval, in seconds, mentioned in the availabilityChangeURL parameter description. The default value is 3600 (one hour). This parameter is ignored if the availabilityChangeURL parameter is not specified, or if ATP inventory allocation is not enabled. |
noInventoryURL | Specifies the URL to which to redirect if any of the order items in the order cannot be allocated or backordered. This parameter is ignored if ATP inventory allocation is not enabled. |
quotationSubmission | Controls whether the relType attribute values for "selection" OrderQuotationRel objects that identify the order being processed with their childId attribute must be changed to "submission". A value of 0 does not change the relType attributes of the OrderQuotationRel objects in the list to indicate "submission". A value of 1 changes the relType attributes of the OrderQuotationRel objects in the list to indicate "submission". The default value is 0. |
reduceParentQuantities | Controls whether quantities of order items in the selection parent order are reduced by the quantities of order items in the order being processed. A value of 0 does not reduce parent quantities; a value of 1 reduces parent quantities. The default value is 0. In any case, the parent order is only updated when:
|
transferMode | Specifies the mode of transfer to an external system. A value of 0 transfers the order without payment information (shopping-cart transfer). A value of 1 transfers the order with payment information (purchase-order transfer). The default value of this parameter is 0. |
externalUserId | Specifies a user ID to be sent with the order transfer request. |
externalPassword | Specifies a password for the user ID specified by the externalUserId parameter. |
continue | Controls whether or not order processing continues to the next order when there is a failure in processing one of multiple orders. A value of 0 specifies that the process should not continue; a value of 1 specifies that the process should continue. The default value is 0. |
isPIAddNeeded | Controls whether the PIAddCmd is to be called or not. |
payMethodId | the payment method ID. If this parameter is not set, the command will use policyId to determine a payment method ID. |
policyId | the payment policy ID. the default policy ID is "-9810". |
billing_address_id | the billing address Id of the Payment Instruction. If this parameter is not set, it will use the billing address of the order. |
notify_[msgtype]_transportname_attributename | Specifies configuration attributes applicable to order notification for a given message type and message transport. Message type is optional. If it is not specified, the configuration attribute is applicable to all message types. For example: Send the "order received" e-mail notification for orders processed by this command to 2 e-mail addresses, john@ibm.com and victor@ibm.com: notify_OrderReceived_EMailSender_recipient=john@ibm.com,victor@ibm.com where OrderReceived is from MSGTYPES.NAME and EMailSender is from TRANSPORT.NAME. Send all types of order e-mail notifications to jack@ibm.com: notify_EMailSender_recipient=jack@ibm.com where EMailSender is from TRANSPORT.NAME. Note: If you want to send an e-mail notification to a guest customer, then you must capture the e-mail address of the guest customer. Set the e-mail address as the value of the notify_[msgtype]_transportname_attributename parameter. |
billtoAddressId_i | The reference number of the address to bill for the group i. |
orderId_i | (Required) The reference number of the order to be processed. This parameter can be repeated. |
notifyMerchant_i | Whether the store is notified when the order processing is complete. E-mail notifications are only sent when WebSphere Commerce is configured with WebSphere Commerce Payments. 1=Yes, 0=No |
notifyShopper_i | Whether the customer is notified when the order processing is complete for the enumeration group i. E-mail notifications are only sent when WebSphere Commerce is configured with WebSphere Commerce Payments. 1=Yes, 0=No |
notifyOrderSubmitted_i | Specifies whether the customer is notified when the order is successfully submitted for processing for the enumeration group i. 1=Yes0=No (default) |
field1_i | Customizable fields1 for the group i. |
field2_i | Customizable fields2 for the group i. |
field3_i | Customizable fields3 for the group i. |
PONumber_i | the purchase order Id for this order for the group i. If the purchaseorder_id is specified, this value will be replaced. |
purchaseorder_id_i | the purchase order Id for this order for the group i. |
Name | Description |
---|---|
orderId | the orders Id processed. This parameter can be repeated. |
warningErrorMessage | the warning error message for the first order. |
warningErrorMessageKey | the warning error message key for the first order. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM copyright notice field.
|
static java.lang.Short | VAL_NOTIFY_NO
Constant VAL_NOTIFY_NO.
|
static java.lang.Short | VAL_NOTIFY_YES
Constant VAL_NOTIFY_YES.
|
Constructor and Description |
---|
OrderProcessCmdImpl() |
Modifier and Type | Method and Description |
---|---|
protected void | addToBusinessEventData(OrderAccessBean abOrder)
This method adds the order to the business event data.
|
static void | checkInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext)
This helper method which calls the default implementation of the CheckInventoryCmd task command This method is deprecated.
|
static void | checkInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName)
This is a helper method that calls a specified implementation of the CheckInventoryCmd task command This method is deprecated.
|
static void | extendOrderProcess(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext, TypedProperty ahshRequestProperties)
This is a helper method that calls the ExtOrderProcessCmd task command
|
java.lang.String | getAvailabilityChangeURL()
Gets the URL to redirect to.
|
java.lang.Long | getBillToRn()
Gets the reference number of the address to bill.
|
boolean | getContinue()
Gets the value of the 'continue' policy.
|
java.lang.String | getExternalPassword()
Gets the external password
|
java.lang.String | getExternalUserId()
Gets the external user id
|
java.lang.Integer | getField1()
Gets merchant-customizable field one.
|
java.math.BigDecimal | getField2()
Gets merchant-customizable field two.
|
java.lang.String | getField3()
Gets merchant-customizable field three.
|
java.lang.Long | getMaxAvailabilityChange()
Gets the time interval, in seconds, used with the url set by the setAvailabilityChangeURL method.
|
java.lang.String | getNoInventoryURL()
Gets the URL to redirect to if any of the order items in the order cannot be allocated or backordered.
|
java.util.Hashtable | getNotificationAttributes()
Gets the attributes for order notification
|
java.lang.Short | getNotifyMerchant()
Determines whether the store should be notified when the order processing is complete.
|
java.lang.Short | getNotifyOrderSubmitted()
Determines whether the customer should be notified when the order is successfully submitted for processing.
|
java.lang.Short | getNotifyShopper()
Determines whether the customer should be notified when the order processing is complete.
|
java.lang.Long | getOrderRn()
Deprecated.
Replaced by [0]
|
java.lang.String[] | getOrderRns()
Gets the order ids for processed orders
|
OrderAccessBean[] | getOrders()
Gets the orders to be processed
|
java.lang.String | getQuotationSubmission()
Gets the quotationSubmission parameter.
|
java.lang.String | getQuoteExpiredURL()
Gets the URL to redirect to if the order total expired in agreement with the expiry policy set by the setQuoteExpiryPolicy method.
|
java.lang.String | getQuoteExpiryPolicy()
Gets the policy which determines the command behavior if the order total expires or an order item's fulfillment center changes during inventory allocation.
|
java.lang.String | getReduceParentQuantities()
Gets the reduceParentQuantities parameter.
|
AccessVector | getResources()
Gets the resources.
|
protected java.lang.String | getTransferMode()
Gets the transferMode property of the command.
|
protected void | handleRecurringOrder() |
protected void | handleSubscription() |
static void | invokeOrderMessaging(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext, TypedProperty ahshRequestProperties)
This is a helper method that calls the OrderMessagingCmd task command
|
boolean | isPerformPIAdd()
Returns whether PIAddCmd will be called.
|
boolean | isReadyToCallExecute()
This method checks the validity of the parameters
|
protected boolean | isUBFEnabled()
This method returns a boolean value to indicate whether UBF is enabled.
|
boolean | isUpdateOrderChannel()
Returns whether to update channel id.
|
void | performExecute()
This method contains the main business logic of this command implementation.
|
protected void | processPIAdd(OrderAccessBean abOrder, CommandContext cmdContext)
Call PIAdd if needed
|
protected void | raiseBusinessEvents()
This method raises ORDER_SUBMISSION_EVENT for orders that have been processed (submitted).
|
void | reset()
This method should be called after a command has been executed to reset its states variables.
|
static void | reverseUpdateInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext)
A helper method that calls the default implementation of the ReverseUpdateInventoryCmd task command
|
static void | reverseUpdateInventory(java.lang.Long orderId, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName)
A helper method that calls a specified implementation of ReverseUpdateInventoryCmd
|
void | setAvailabilityChangeURL(java.lang.String newAvailabilityChangeURL)
Sets the URL to redirect to.
|
void | setBillToRn(java.lang.Long anBillToRn)
Sets the reference number of the address to bill.
|
void | setContinue(boolean aContinue)
Sets the value of the 'continue' policy.
|
void | setExternalPassword(java.lang.String astrExternalPassword)
Sets the external password
|
void | setExternalUserId(java.lang.String astrExternalUserId)
Sets the external user id
|
void | setField1(java.lang.Integer anField1)
Sets merchant-customizable field one.
|
void | setField2(java.math.BigDecimal adField2)
Sets merchant-customizable field two.
|
void | setField3(java.lang.String astrField3)
Sets merchant-customizable field three.
|
void | setMaxAvailabilityChange(java.lang.Long newMaxAvailabilityChange)
Sets the time interval, in seconds, used with the url set by the setAvailabilityChangeURL method.
|
void | setNoInventoryURL(java.lang.String newNoInventoryURL)
Sets the URL to redirect to if any of the order items in the order cannot be allocated or backordered.
|
void | setNotificationAttributes(java.util.Hashtable aNotificationAttributes)
Sets the attributes for order notification
|
void | setNotifyMerchant(java.lang.Short newNotifyMerchant)
Specifies whether the store should be notified when the order processing is complete.
|
void | setNotifyOrderSubmitted(java.lang.Short newNotifyOrderSubmitted)
Specifies whether the customer should be notified when the order is successfully submitted for processing.
|
void | setNotifyShopper(java.lang.Short newNotifyShopper)
Specifies whether the customer should be notified when the order processing is complete.
|
void | setOrderRn(java.lang.Long anOrderRn)
Sets the order reference number.
|
void | setOrderRns(java.lang.String[] anOrderRns)
Sets the orders to be processed
|
void | setOrders(OrderAccessBean[] anabOrders)
Sets the orders to be processed
|
void | setPerformPIAdd(boolean piAddNeeded)
Sets whether PIAddCmd will be called.
|
void | setQuotationSubmission(java.lang.String astrQuotationSubmission)
Sets the quotationSubmission parameter.
|
void | setQuoteExpiredURL(java.lang.String newQuoteExpiredURL)
Sets the URL to redirect to if the order total expired in agreement with the expiry policy set by the setQuoteExpiryPolicy method.
|
void | setQuoteExpiryPolicy(java.lang.String newQuoteExpiryPolicy)
Sets the behavior of the command if the order total expires or an order item's fulfillment center changes during inventory allocation.
|
void | setReduceParentQuantities(java.lang.String astrReduceParentQuantities)
Sets the reduceParentQuantities parameter.
|
void | setRequestProperties(TypedProperty reqParms)
The WebController calls the setRequestProperties method before invoking the execute method in this command.
|
void | setTransferMode(java.lang.String transferMode)
Sets the transferMode property of the command.
|
void | setUpdateOrderChannel(boolean updateChannel)
Sets whether to update channel id
|
static void | updateInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext)
A helper method that calls the default implementation of the UpdateInventoryCmd task command
|
static void | updateInventory(java.lang.Long orderId, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName)
A helper method that calls a specified implementation of UpdateInventoryCmd
|
void | validateParameters()
This method performs server side parameter checking.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.Short VAL_NOTIFY_YES
public static final java.lang.Short VAL_NOTIFY_NO
public static void checkInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext) throws ECException, javax.ejb.FinderException, java.rmi.RemoteException, javax.naming.NamingException, javax.ejb.CreateException
public static void checkInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName) throws ECException, javax.ejb.FinderException, java.rmi.RemoteException, javax.naming.NamingException, javax.ejb.CreateException
public static void extendOrderProcess(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext, TypedProperty ahshRequestProperties) throws ECException
public java.lang.String getAvailabilityChangeURL()
public java.lang.Long getBillToRn()
public java.lang.Integer getField1()
public java.math.BigDecimal getField2()
public java.lang.String getField3()
public java.lang.Long getMaxAvailabilityChange()
public java.lang.String getNoInventoryURL()
public java.lang.Short getNotifyMerchant()
public java.lang.Short getNotifyOrderSubmitted()
public java.lang.Short getNotifyShopper()
public java.lang.String getQuotationSubmission()
public java.lang.Long getOrderRn()
public java.lang.String getQuoteExpiredURL()
public java.lang.String getQuoteExpiryPolicy()
public java.lang.String getReduceParentQuantities()
public AccessVector getResources() throws ECException
public static void invokeOrderMessaging(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext, TypedProperty ahshRequestProperties) throws ECException
public boolean isReadyToCallExecute()
public void performExecute() throws ECException
protected void handleRecurringOrder() throws ECException
protected void handleSubscription() throws ECException
protected void processPIAdd(OrderAccessBean abOrder, CommandContext cmdContext) throws ECException, java.rmi.RemoteException, javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException
protected void addToBusinessEventData(OrderAccessBean abOrder) throws ECSystemException
public void reset()
public static void reverseUpdateInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext) throws ECException
public static void reverseUpdateInventory(java.lang.Long orderId, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName) throws ECException
public void setAvailabilityChangeURL(java.lang.String newAvailabilityChangeURL)
public void setBillToRn(java.lang.Long anBillToRn)
public void setField1(java.lang.Integer anField1)
public void setField2(java.math.BigDecimal adField2)
public void setField3(java.lang.String astrField3)
public void setMaxAvailabilityChange(java.lang.Long newMaxAvailabilityChange)
public void setNoInventoryURL(java.lang.String newNoInventoryURL)
public void setNotifyMerchant(java.lang.Short newNotifyMerchant)
1=Yes
0=No
public void setNotifyOrderSubmitted(java.lang.Short newNotifyOrderSubmitted)
1=Yes
0=No (default)
public void setNotifyShopper(java.lang.Short newNotifyShopper)
1=Yes
0=No
public void setQuotationSubmission(java.lang.String astrQuotationSubmission)
public void setOrderRn(java.lang.Long anOrderRn)
public void setQuoteExpiredURL(java.lang.String newQuoteExpiredURL)
public void setQuoteExpiryPolicy(java.lang.String newQuoteExpiryPolicy)
public void setReduceParentQuantities(java.lang.String astrReduceParentQuantities)
public void setTransferMode(java.lang.String transferMode)
protected java.lang.String getTransferMode()
public void setRequestProperties(TypedProperty reqParms) throws ECApplicationException
public static void updateInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext) throws ECException
public static void updateInventory(java.lang.Long orderId, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName) throws ECException
public void validateParameters() throws ECException
public java.lang.String getExternalUserId()
public void setExternalUserId(java.lang.String astrExternalUserId)
public java.lang.String getExternalPassword()
public void setExternalPassword(java.lang.String astrExternalPassword)
public java.lang.String[] getOrderRns()
public void setOrderRns(java.lang.String[] anOrderRns)
protected boolean isUBFEnabled()
public OrderAccessBean[] getOrders()
public void setOrders(OrderAccessBean[] anabOrders)
public boolean getContinue()
public void setContinue(boolean aContinue)
public java.util.Hashtable getNotificationAttributes()
public void setNotificationAttributes(java.util.Hashtable aNotificationAttributes)
protected void raiseBusinessEvents() throws ECSystemException
public boolean isPerformPIAdd()
public void setPerformPIAdd(boolean piAddNeeded)
public boolean isUpdateOrderChannel()
public void setUpdateOrderChannel(boolean updateChannel)