com.ibm.commerce.order.commands

Interface ProcessOrderCmd

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      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.
      • Fields inherited from interface com.ibm.websphere.command.Command

        serialVersionUID
    • Field Detail

      • COPYRIGHT

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

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

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

        static final java.lang.Short VAL_NOTIFY_NO
        Notify no.
      • VAL_NOTIFY_YES

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

      • getResponseProperties

        TypedProperty getResponseProperties()
        This method gets the response properties object for the calling controller command to use.
        Returns:
        response properties
      • setAvailabilityChangeURL

        void setAvailabilityChangeURL(java.lang.String newAvailabilityChangeURL)
        Sets 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 setMaxAvailabilityChange method, this method is called. This parameter is ignored if ATP inventory allocation is not enabled.
        Parameters:
        newAvailabilityChangeURL - URL
      • setBillToRn

        void setBillToRn(java.lang.Long anBillToRn)
        This method sets the reference number of the address to bill.
        Parameters:
        anBillToRn - address id
      • setField1

        void setField1(java.lang.Integer anField1)
        This method sets merchant-customizable field one.
        Parameters:
        anField1 - field1
      • setField2

        void setField2(java.math.BigDecimal adField2)
        This method sets merchant-customizable field two.
        Parameters:
        adField2 - field2
      • setField3

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

        void setMaxAvailabilityChange(java.lang.Long newMaxAvailabilityChange)
        This method 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

        void setNoInventoryURL(java.lang.String newNoInventoryURL)
        This method 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

        void setNotifyMerchant(java.lang.Short anNotifyMerchant)
        This method 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

        void setNotifyOrderSubmitted(java.lang.Short anNotifyOrderSubmitted)
        This method 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

        void setNotifyShopper(java.lang.Short anNotifyShopper)
        This method 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

        void setOrderRn(java.lang.Long anOrderRn)
        This method sets the order reference number.
        Parameters:
        anOrderRn - order id
      • setQuotationSubmission

        void setQuotationSubmission(java.lang.String astrQuotationSubmission)
        This method sets the quotationSubmission parameter.
        Parameters:
        astrQuotationSubmission -
      • setQuoteExpiredURL

        void setQuoteExpiredURL(java.lang.String newQuoteExpiredURL)
        This method 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

        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 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:

        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

        void setReduceParentQuantities(java.lang.String astrReduceParentQuantities)
        This method sets the reduceParentQuantities parameter.
        Parameters:
        astrReduceParentQuantities -
      • setTransferMode

        void setTransferMode(java.lang.String transferMode)
        This method 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

        void setExternalUserId(java.lang.String astrExternalUserId)
        This method sets the external user id
        Parameters:
        astrExternalUserId - The external user id to set
      • setExternalPassword

        void setExternalPassword(java.lang.String astrExternalPassword)
        This method sets the external password
        Parameters:
        astrExternalPassword - The external password to set
      • setNotificationAttributes

        void setNotificationAttributes(java.util.Hashtable aNotificationAttributes)
        This method sets the attributes for order notification
        Parameters:
        aNotificationAttributes - The attributes to set
      • getPoNumber

        java.lang.String getPoNumber()
        This method gets the parameter PO number
        Returns:
        The poNumber.
      • setPoNumber

        void setPoNumber(java.lang.String poNumber)
        This method sets the parameter PO number
        Parameters:
        poNumber - The poNumber to set.