|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
|
static java.lang.Short |
VAL_NOTIFY_NO
|
static java.lang.Short |
VAL_NOTIFY_YES
|
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. |
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.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()
Gets the order reference number. |
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. |
AccessVector |
getResources()
Gets the access vector accessed by this 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 |
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 |
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 |
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 |
setRequestProperties(TypedProperty reqParms)
The WebController calls the setRequestProperties method before invoking the execute method in this 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 |
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
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, setAccCheck, setForUserId, setOwner |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties |
Methods inherited from interface com.ibm.commerce.security.Protectable |
fulfills, getOwner |
Field Detail |
public static final java.lang.String COPYRIGHT
public static final java.lang.Short VAL_NOTIFY_NO
public static final java.lang.Short VAL_NOTIFY_YES
Constructor Detail |
public OrderProcessCmdImpl()
Method Detail |
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
anOrderRn
- Order reference numberanStoreId
- Store reference numberaProcessingContext
- Command contextpublic 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
anOrderRn
- Order reference numberanStoreId
- Store reference numberaProcessingContext
- Command contextastrTaskName
- Name of the task command to use to checkInventorypublic 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 pairspublic 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.Long getOrderRn()
public java.lang.String getQuoteExpiredURL()
public java.lang.String getQuoteExpiryPolicy()
public AccessVector getResources() throws ECException
ECCommand
getResources
in interface ECCommand
getResources
in class AbstractECTargetableCommand
com.ibm.commerce.command.ECCommand
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 pairspublic boolean isReadyToCallExecute()
isReadyToCallExecute
in class AbstractECTargetableCommand
com.ibm.commerce.command.AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface ECCommand
performExecute
in class AbstractECTargetableCommand
com.ibm.commerce.command.ECCommand
com.ibm.commerce.command.CommandException
- The superclass for all ECExceptions.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 contextpublic static void reverseUpdateInventory(java.lang.Long orderId, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName) throws ECException
anOrderRn
- Order reference numberanStoreId
- Store reference numberaProcessingContext
- Command contextastrTaskName
- Name of the task command to use to Reverse Update Inventorypublic void setAvailabilityChangeURL(java.lang.String newAvailabilityChangeURL)
setAvailabilityChangeURL
in interface OrderProcessCmd
public void setBillToRn(java.lang.Long anBillToRn)
setBillToRn
in interface OrderProcessCmd
public void setField1(java.lang.Integer anField1)
setField1
in interface OrderProcessCmd
public void setField2(java.math.BigDecimal adField2)
setField2
in interface OrderProcessCmd
public void setField3(java.lang.String astrField3)
setField3
in interface OrderProcessCmd
public void setMaxAvailabilityChange(java.lang.Long newMaxAvailabilityChange)
setMaxAvailabilityChange
in interface OrderProcessCmd
public void setNoInventoryURL(java.lang.String newNoInventoryURL)
setNoInventoryURL
in interface OrderProcessCmd
public void setNotifyMerchant(java.lang.Short newNotifyMerchant)
1=Yes
0=No
setNotifyMerchant
in interface OrderProcessCmd
public void setNotifyOrderSubmitted(java.lang.Short newNotifyOrderSubmitted)
1=Yes
0=No (default)
setNotifyOrderSubmitted
in interface OrderProcessCmd
public void setNotifyShopper(java.lang.Short newNotifyShopper)
1=Yes
0=No
setNotifyShopper
in interface OrderProcessCmd
public void setOrderRn(java.lang.Long anOrderRn)
setOrderRn
in interface OrderProcessCmd
public void setQuoteExpiredURL(java.lang.String newQuoteExpiredURL)
setQuoteExpiredURL
in interface OrderProcessCmd
public void setQuoteExpiryPolicy(java.lang.String newQuoteExpiryPolicy)
setQuoteExpiryPolicy
in interface OrderProcessCmd
public void setRequestProperties(TypedProperty reqParms) throws ECApplicationException
setRequestProperties
in interface ControllerCommand
setRequestProperties
in class ControllerCommandImpl
com.ibm.commerce.command.ControllerCommand
requestProperties
- com.ibm.commerce.datatype.TypedPropertycom.ibm.commerce.exception.ECException.
- public static void updateInventory(java.lang.Long anOrderRn, java.lang.Integer anStoreId, CommandContext aProcessingContext) throws ECException
anOrderRn
- Order reference numberanStoreId
- Store reference numberaProcessingContext
- Command contextpublic static void updateInventory(java.lang.Long orderId, java.lang.Integer anStoreId, CommandContext aProcessingContext, java.lang.String astrTaskName) throws ECException
anOrderRn
- Order reference numberanStoreId
- Store reference numberaProcessingContext
- Command contextastrTaskName
- Name of the task command to use to Update Inventorypublic void validateParameters() throws ECException
validateParameters
in interface ECCommand
validateParameters
in class AbstractECTargetableCommand
com.ibm.commerce.command.ECCommand
ECException.
-
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |