java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.order.commands.OrderProcessCmdImpl
This command submits an order. The order must have been locked by OrderPrepare. Once the OrderProcess command begins running, the order cannot be cancelled with OrderCancel.
Behaviour
OrderProcess command
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
static java.lang.Short |
VAL_NOTIFY_NO Constant. |
static java.lang.Short |
VAL_NOTIFY_YES Constant. |
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl |
requestProperties,
responseProperties,
retriable,
viewReqProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.order.commands. OrderProcessCmd |
DEFAULT_MAX_AVAILABILITY_CHANGE,
defaultCommandClassName,
NAME |
Constructor Summary | |
---|---|
OrderProcessCmdImpl() |
Method Summary | |
---|---|
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 when the estimated availability time plus the shipping offset for any order item moves into the future (as a result of allocating or backordering inventory) by more than the time interval specified by the setMaxAvailabilityChange method. |
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. |
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 behaviour 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. |
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 |
isReadyToCallExecute() Checks the validity of the parameters |
void |
performExecute() Main business logic |
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 when the estimated availability time plus the shipping offset for any order item moves into the future (as a result of allocating or backordering inventory) by more than the time interval specified by the setMaxAvailabilityChange method. |
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 |
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. |
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() Performs server side parameter checking. |
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
getViewInputProperties,
isGeneric,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. ControllerCommand |
checkPermission,
execute,
getGeneric,
getRequestProperties,
getResolvedRequestProperties,
getResponseProperties,
getRetriable,
getViewInputProperties,
isGeneric,
isRetriable,
mergeProperties,
setGeneric,
setRetriable,
setViewInputProperties |
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,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
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
Constructor Detail |
---|
public OrderProcessCmdImpl()
Method Detail |
---|
public static void checkInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext) throws ECException, FinderException, java.rmi.RemoteException, javax.naming.NamingException, CreateException
anOrderRn
- Order reference numberanStoreId
- Store reference numberaProcessingContext
- Command contextECException
CreateException
FinderException
javax.naming.NamingException
java.rmi.RemoteException
public static void checkInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName) throws ECException, FinderException, java.rmi.RemoteException, javax.naming.NamingException, CreateException
anOrderRn
- Order reference numberanStoreId
- Store reference numberaProcessingContext
- Command contextastrTaskName
- Name of the task command to use to
checkInventoryECException
CreateException
FinderException
javax.naming.NamingException
java.rmi.RemoteException
public static void extendOrderProcess(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext, TypedProperty ahshRequestProperties) throws ECException
anOrderRn
- Order reference number to do extended processing
onanStoreId
- Store reference numberaProcessingContext
- Command contextahshRequestProperties
- Name value pairsECException
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
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
public static void invokeOrderMessaging(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext, TypedProperty ahshRequestProperties) throws ECException
anOrderRn
- Order reference number to do extended processing
onanStoreId
- Store reference numberaProcessingContext
- Command contextahshRequestProperties
- Name value pairsECException
public boolean isReadyToCallExecute()
isReadyToCallExecute
in class
AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
public void reset()
reset
in class
AbstractECTargetableCommand
public static void reverseUpdateInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext) throws ECException
anOrderRn
- Order reference numberanStoreId
- Store reference numberaProcessingContext
- Command contextECException
public static void reverseUpdateInventory(java.lang.Long orderId, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName) throws ECException
anStoreId
- Store reference numberaProcessingContext
- Command contextastrTaskName
- Name of the task command to use to Reverse
Update InventoryECException
public void setAvailabilityChangeURL(java.lang.String newAvailabilityChangeURL)
setAvailabilityChangeURL
in interface
OrderProcessCmd
newAvailabilityChangeURL
- URL.public void setBillToRn(java.lang.Long anBillToRn)
setBillToRn
in interface
OrderProcessCmd
anBillToRn
- address id.public void setField1(java.lang.Integer anField1)
setField1
in interface
OrderProcessCmd
anField1
- field1public void setField2(java.math.BigDecimal adField2)
setField2
in interface
OrderProcessCmd
adField2
- field2public void setField3(java.lang.String astrField3)
setField3
in interface
OrderProcessCmd
astrField3
- filed3public void setMaxAvailabilityChange(java.lang.Long newMaxAvailabilityChange)
setMaxAvailabilityChange
in interface
OrderProcessCmd
newMaxAvailabilityChange
- time interval.public void setNoInventoryURL(java.lang.String newNoInventoryURL)
setNoInventoryURL
in interface
OrderProcessCmd
newNoInventoryURL
- URLpublic void setNotifyMerchant(java.lang.Short newNotifyMerchant)
1=Yes
0=No
setNotifyMerchant
in interface
OrderProcessCmd
newNotifyMerchant
- notify merchant
parameter.public void setNotifyOrderSubmitted(java.lang.Short newNotifyOrderSubmitted)
1=Yes
0=No (default)
setNotifyOrderSubmitted
in interface
OrderProcessCmd
newNotifyOrderSubmitted
- notify order submitted
parameter.public void setNotifyShopper(java.lang.Short newNotifyShopper)
1=Yes
0=No
setNotifyShopper
in interface
OrderProcessCmd
newNotifyShopper
- notify shopper
parameter.public void setQuotationSubmission(java.lang.String astrQuotationSubmission)
setQuotationSubmission
in interface
OrderProcessCmd
astrQuotationSubmission
- quotation submission
parameter.public void setOrderRn(java.lang.Long anOrderRn)
setOrderRn
in interface
OrderProcessCmd
anOrderRn
- order id.public void setQuoteExpiredURL(java.lang.String newQuoteExpiredURL)
setQuoteExpiredURL
in interface
OrderProcessCmd
newQuoteExpiredURL
- URL.public void setQuoteExpiryPolicy(java.lang.String newQuoteExpiryPolicy)
setQuoteExpiryPolicy
in interface
OrderProcessCmd
newQuoteExpiryPolicy
- quote expiry
policy.public void setReduceParentQuantities(java.lang.String astrReduceParentQuantities)
setReduceParentQuantities
in interface
OrderProcessCmd
astrReduceParentQuantities
- reduce parent quantities
parameter.public void setTransferMode(java.lang.String transferMode)
setTransferMode
in interface
OrderProcessCmd
transferMode
- - 0 - order has been transferred without the
payment information (shopping cart transfer). 1 - order has been transferred
with the payment information (purchase order transfer).protected java.lang.String getTransferMode()
public void setRequestProperties(TypedProperty reqParms) throws ECApplicationException
setRequestProperties
in interface
ControllerCommand
setRequestProperties
in class
ControllerCommandImpl
reqParms
- request properties.
ECApplicationException
public static void updateInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext) throws ECException
anOrderRn
- Order reference numberanStoreId
- Store reference numberaProcessingContext
- Command contextECException
public static void updateInventory(java.lang.Long orderId, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName) throws ECException
anStoreId
- Store reference numberaProcessingContext
- Command contextastrTaskName
- Name of the task command to use to Update
InventoryECException
public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException
public java.lang.String getExternalUserId()
public void setExternalUserId(java.lang.String astrExternalUserId)
setExternalUserId
in interface
OrderProcessCmd
astrExternalUserId
- The external user id to
setpublic java.lang.String getExternalPassword()
public void setExternalPassword(java.lang.String astrExternalPassword)
setExternalPassword
in interface
OrderProcessCmd
astrExternalPassword
- The external password to
setpublic java.lang.String[] getOrderRns()
public void setOrderRns(java.lang.String[] anOrderRns)
public OrderAccessBean[] getOrders()
public void setOrders(OrderAccessBean[] anabOrders)
anabOrders
- The orders to setpublic boolean getContinue()
public void setContinue(boolean aContinue)
aContinue
- The value to setpublic java.util.Hashtable getNotificationAttributes()
public void setNotificationAttributes(java.util.Hashtable aNotificationAttributes)
setNotificationAttributes
in interface
OrderProcessCmd
aNotificationAttributes
- The attributes to
set