com.ibm.commerce.order.commands
Interface ProcessOrderCmd

All Superinterfaces:
TaskCommand
All Known Subinterfaces:
PreProcessOrderCmd
All Known Implementing Classes:
PreProcessOrderCmdImpl, ProcessOrderCmdImpl

public interface ProcessOrderCmd
extends TaskCommand

This command submits an order.


Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String NAME
          The name of the Command Interface class.
static java.lang.Short VAL_NOTIFY_NO
          Notify no.
static java.lang.Short VAL_NOTIFY_YES
          Notify yes.
 
Method Summary
  TypedProperty getResponseProperties()
          Gets the response properties object for the calling controller command to use.
 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 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 anNotifyMerchant)
          Specifies whether to notify the merchant when the order has been processed.
 void setNotifyOrderSubmitted(java.lang.Short anNotifyOrderSubmitted)
          Specifies whether the customer should be notified when the order is successfully submitted for processing.
 void setNotifyShopper(java.lang.Short anNotifyShopper)
          Specifies whether to notify the shopper when the order has been processed.
 void setOrderRn(java.lang.Long anOrderRn)
          Sets the order reference number.
 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 aRequestProperties)
          Sets the request properties.
 void setTransferMode(java.lang.String transferMode)           Sets the transferMode property of the command.
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of the Command Interface class.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.
See Also:
Constant Field Values

VAL_NOTIFY_NO

public static final java.lang.Short VAL_NOTIFY_NO
Notify no.

VAL_NOTIFY_YES

public static final java.lang.Short VAL_NOTIFY_YES
Notify yes.
Method Detail

getResponseProperties

public TypedProperty getResponseProperties()
Gets the response properties object for the calling controller command to use.
Returns:
response properties

setAvailabilityChangeURL

public 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. This parameter is ignored if ATP inventory allocation is not enabled.
Parameters:
newAvailabilityChangeURL - URL

setBillToRn

public void setBillToRn(java.lang.Long anBillToRn)
Sets the reference number of the address to bill.
Parameters:
anBillToRn - address id

setField1

public void setField1(java.lang.Integer anField1)
Sets merchant-customizable field one.
Parameters:
anField1 - field1

setField2

public void setField2(java.math.BigDecimal adField2)
Sets merchant-customizable field two.
Parameters:
adField2 - field2

setField3

public void setField3(java.lang.String astrField3)
Sets merchant-customizable field three.
Parameters:
astrField3 - field3

setMaxAvailabilityChange

public void setMaxAvailabilityChange(java.lang.Long newMaxAvailabilityChange)
Sets the time interval, in seconds, used with the url set by the setAvailabilityChangeURL method. The default value is 3600 (one hour). This parameter is ignored if the availabilityChangeURL is not specified, or if ATP inventory allocation is not enabled.
Parameters:
newMaxAvailabilityChange -

setNoInventoryURL

public 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. This parameter is ignored if ATP inventory allocation is not enabled.
Parameters:
newNoInventoryURL - URL

setNotifyMerchant

public void setNotifyMerchant(java.lang.Short anNotifyMerchant)
Specifies whether to notify the merchant when the order has been processed. If the value set to 1, the merchant will be notified. If the value is set to 0, the merchant will not be notified.
Parameters:
anNotifyMerchant -

setNotifyOrderSubmitted

public void setNotifyOrderSubmitted(java.lang.Short anNotifyOrderSubmitted)
Specifies whether the customer should be notified when the order is successfully submitted for processing. Valid values include :

1=Yes

0=No (default)

Parameters:
anNotifyOrderSubmitted -

setNotifyShopper

public void setNotifyShopper(java.lang.Short anNotifyShopper)
Specifies whether to notify the shopper when the order has been processed. If the value set to 1, the shopper will be notified. If the value is set to 0, the shopper will not be notified.
Parameters:
anNotifyShopper -

setOrderRn

public void setOrderRn(java.lang.Long anOrderRn)
Sets the order reference number.
Parameters:
anOrderRn - order id

setQuotationSubmission

public void setQuotationSubmission(java.lang.String astrQuotationSubmission)
Sets the quotationSubmission parameter.
Parameters:
astrQuotationSubmission -

setQuoteExpiredURL

public 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.
Parameters:
newQuoteExpiredURL - URL

setQuoteExpiryPolicy

public 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. Order total expires if the current time is greater than or equal to 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:
  1. alwaysProceed - always proceed with processing the order after recalculating order total.
  2. 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 set by the setQuoteExpiredUrl method.
  3. neverProceed - always redirect to the URL specified by the set by the setQuoteExpiredUrl method.
Parameters:
newQuoteExpiryPolicy - quote expiry policy

setReduceParentQuantities

public void setReduceParentQuantities(java.lang.String astrReduceParentQuantities)
Sets the reduceParentQuantities parameter.
Parameters:
astrReduceParentQuantities -

setTransferMode

public void setTransferMode(java.lang.String transferMode)
Sets the transferMode property of the command.
Parameters:
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).

setExternalUserId

public void setExternalUserId(java.lang.String astrExternalUserId)
Sets the external user id
Parameters:
astrExternalUserId - The external user id to set

setExternalPassword

public void setExternalPassword(java.lang.String astrExternalPassword)
Sets the external password
Parameters:
astrExternalPassword - The external password to set

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Sets the request properties.
Parameters:
aRequestProperties - request properties
Throws:
ECApplicationException

setNotificationAttributes

public void setNotificationAttributes(java.util.Hashtable aNotificationAttributes)
Sets the attributes for order notification
Parameters:
aNotificationAttributes - The attributes to set