com.ibm.commerce.rest.bod.helpers

Class OrderHelper

  • java.lang.Object
    • com.ibm.commerce.rest.bod.helpers.OrderHelper

  • public class OrderHelper
extends java.lang.Object
    This class provides helper methods to get and update data for Order noun using OrderFacadeClient.

    • Constructor Summary

      Constructors 
      Constructor and Description
      OrderHelper() 
      OrderHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor)
      Instantiates a new order helper.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Map<java.lang.String,java.lang.Object> applyCoupon(java.util.Map<java.lang.String,java.lang.Object> parameters, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      Apply coupon to the order.
      java.util.Map<java.lang.String,java.lang.Object> applyPromoCode(java.util.Map<java.lang.String,java.lang.Object> parameters, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      Apply promotion code to the order.
      void cancelOrderInCart(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler cbh)
      This method cancel the current shopping cart.
      static java.util.Map<java.lang.String,java.lang.Object> convertPIRequestMap(java.util.Map<java.lang.String,java.lang.Object> requestMap)
      This method converts the original request map into the map format that is accepted by BOD mapping utility.
      java.util.Map<java.lang.String,java.lang.Object> deletePaymentInst(java.util.Map<java.lang.String,java.lang.String> parameters, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      Delete payment instruction.
      ShowOrderDataAreaType getCurrentShoppingCart(boolean isSummary, CommonOrderFacadeClient iClient)
      Gets the current shopping cart.
      com.ibm.commerce.rest.utils.Instrumentor getInstrumentor()
      Get the instrumentor associated with this request instance.
      commonj.sdo.DataObject getOrder(BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh, java.lang.String expression, java.lang.String accessProfile, int pageNumber, int pageSize)
      This method performs a GetOrder service request and returns DataObject for DataArea.
      java.lang.String getOrderId(BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh, java.lang.String expression)
      This method returns the orderid.
      java.lang.String[] getPaymentInstructionsIds(BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh, java.lang.String expression)
      This method returns all the pay instructions that are related to the current order.
      java.util.Map<java.lang.String,java.lang.Object> lockOrder(java.util.Map<java.lang.String,java.lang.Object> parameters, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      CSR locks the order
      java.util.Map<java.lang.String,java.lang.Object> prepareOrder(java.util.Map<java.lang.String,java.lang.Object> parameters, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      This method prepare the order to be submitted.
      java.util.Map<java.lang.String,java.lang.Object> processOrChangeOrder(java.lang.String resourceName, java.lang.String urlParamGrpName, java.lang.String verb, java.lang.String actionCode, java.util.Map requestMap, BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
      Create BOD object and execute it.
      java.util.Map<java.lang.String,java.lang.Object> removeCoupon(java.util.Map<java.lang.String,java.lang.Object> parameters, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      Remove the coupon from order.
      java.util.Map<java.lang.String,java.lang.Object> removePromoCode(java.util.Map<java.lang.String,java.lang.Object> parameters, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      Remove the promotion code from order.
      java.util.Map<java.lang.String,java.lang.Object> submitOrder(java.util.Map<java.lang.String,java.lang.Object> parameters, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      Submits the order to be processed.
      java.util.Map<java.lang.String,java.lang.Object> unlockOrder(java.util.Map<java.lang.String,java.lang.Object> parameters, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      CSR unlocks the order.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • COPYRIGHT

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

      • DEFAULT_ACCESS_PROFILE

        public static final java.lang.String DEFAULT_ACCESS_PROFILE
        The default access profile. It is for order details.
        See Also:
        Constant Field Values

      • ORDER_SUMMARY_ACCESS_PROFILE

        public static final java.lang.String ORDER_SUMMARY_ACCESS_PROFILE
        Access profile for order summary.
        See Also:
        Constant Field Values

      • ORDER_ITEM_CONFIGURATION_ACCESS_PROFILE

        public static final java.lang.String ORDER_ITEM_CONFIGURATION_ACCESS_PROFILE
        Access proflie for order item configuration
        See Also:
        Constant Field Values

      • EXTERNAL_DETAILS_ACCESS_PROFILE

        public static final java.lang.String EXTERNAL_DETAILS_ACCESS_PROFILE
        Access profile for external details
        See Also:
        Constant Field Values

      • EXTERNAL_SUMMARY_ACCESS_PROFILE

        public static final java.lang.String EXTERNAL_SUMMARY_ACCESS_PROFILE
        Access profile for external summary
        See Also:
        Constant Field Values

      • DEFAULT_EXPRESSION

        public static final java.lang.String DEFAULT_EXPRESSION
        The default expression, used to retrieve order in current shopping cart.
        See Also:
        Constant Field Values

      • FIND_BY_ORDERID_XPATH

        public static final java.lang.String FIND_BY_ORDERID_XPATH
        The XPath key to find a Order noun by orderid.
        See Also:
        Constant Field Values

      • FIND_BY_ORDERID_WITH_ORDER_ITEM_XPATH

        public static final java.lang.String FIND_BY_ORDERID_WITH_ORDER_ITEM_XPATH
        The XPath key to find an Order noun by order ID with order item key
        See Also:
        Constant Field Values

      • CAL_USAGE_KEY

        public static final java.lang.String CAL_USAGE_KEY
        The XPath key for calculation usage ids for CalculationInfoType.
        See Also:
        Constant Field Values

      • FIND_BY_STATUS_XPATH

        public static final java.lang.String FIND_BY_STATUS_XPATH
        The XPath key to find a Order noun by status.
        See Also:
        Constant Field Values

      • FIND_ORDER_ITEM_CONFIG_BY_ORDER_ITEM_XPATH

        public static final java.lang.String FIND_ORDER_ITEM_CONFIG_BY_ORDER_ITEM_XPATH
        The XPath key to find an Order item configuration by orderItemId.
        See Also:
        Constant Field Values

      • FIND_CHILD_ORDER_BY_PARENT_ORDER_ID_XPATH

        public static final java.lang.String FIND_CHILD_ORDER_BY_PARENT_ORDER_ID_XPATH
        The XPath key to find a child order by the parent order ID.
        See Also:
        Constant Field Values

      • FIND_CHILD_ORDER_BY_ORDER_ITEM_ID_XPATH

        public static final java.lang.String FIND_CHILD_ORDER_BY_ORDER_ITEM_ID_XPATH
        The XPath key to find a child order by the parent order item ID.
        See Also:
        Constant Field Values

      • FIND_BY_ORDER_STATUS_EXT_XPATH

        public static final java.lang.String FIND_BY_ORDER_STATUS_EXT_XPATH
        The XPath key to find a Order noun by status using the external order ID.
        See Also:
        Constant Field Values

      • FIND_ORDER_DETAILS_EXT_XPATH

        public static final java.lang.String FIND_ORDER_DETAILS_EXT_XPATH
        The XPath key to find a Order details using the external order ID.
        See Also:
        Constant Field Values

      • FIND_SCHEDULED_ORDER_XPATH

        public static final java.lang.String FIND_SCHEDULED_ORDER_XPATH
        The XPath key to find a scheduled order.
        See Also:
        Constant Field Values

      • FIND_ORDER_BY_OMRORDER_XPATH

        public static final java.lang.String FIND_ORDER_BY_OMRORDER_XPATH
        The XPath key to find a Order noun by external order ID and store ID.
        See Also:
        Constant Field Values

      • FIND_ORDER_BY_BUYER_ID_XPATH

        public static final java.lang.String FIND_ORDER_BY_BUYER_ID_XPATH
        The XPath key to find a Order noun by buyer ID and store ID.
        See Also:
        Constant Field Values

    • Constructor Detail

      • OrderHelper

        public OrderHelper()

      • OrderHelper

        public OrderHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor)
        Instantiates a new order helper.
        Parameters:
        instrumentor - the instrumentor

    • Method Detail

      • getInstrumentor

        public com.ibm.commerce.rest.utils.Instrumentor getInstrumentor()
        Get the instrumentor associated with this request instance.
        Returns:
        the instrumentor

      • getOrder

        public commonj.sdo.DataObject getOrder(BusinessContextType bContext,
                                       javax.security.auth.callback.CallbackHandler cbh,
                                       java.lang.String expression,
                                       java.lang.String accessProfile,
                                       int pageNumber,
                                       int pageSize)
                                throws OrderException
        This method performs a GetOrder service request and returns DataObject for DataArea.
        Parameters:
        bContext - the b context
        cbh - the cbh
        expression - the XPath expression.
        accessProfile - the access profile of the get expression.
        pageNumber - the page number
        pageSize - the page size
        Returns:
        the Order noun.
        Throws:
        OrderException - the exception representing the error of the GetOrder request.

      • getOrderId

        public java.lang.String getOrderId(BusinessContextType bContext,
                                   javax.security.auth.callback.CallbackHandler cbh,
                                   java.lang.String expression)
                            throws OrderException
        This method returns the orderid. If expression is for current shopping cart, it will return return the orderid for shopping cart.
        Parameters:
        bContext - business context
        cbh - the cbh
        expression - the XPath expression.
        Returns:
        orderId
        Throws:
        OrderException - the order exception

      • processOrChangeOrder

        public java.util.Map<java.lang.String,java.lang.Object> processOrChangeOrder(java.lang.String resourceName,
                                                                             java.lang.String urlParamGrpName,
                                                                             java.lang.String verb,
                                                                             java.lang.String actionCode,
                                                                             java.util.Map requestMap,
                                                                             BusinessContextType businessContext,
                                                                             javax.security.auth.callback.CallbackHandler callbackHandler)
                                                                      throws java.lang.Exception
        Create BOD object and execute it.
        Parameters:
        resourceName - resource name
        urlParamGrpName - URL parameter group name defined in XML configuration file
        verb - verb
        actionCode - action code
        requestMap - request data
        businessContext - business context
        callbackHandler - callback handler
        Returns:
        response map
        Throws:
        java.lang.Exception - throw exception when error happens

      • cancelOrderInCart

        public void cancelOrderInCart(BusinessContextType businessContext,
                              javax.security.auth.callback.CallbackHandler cbh)
                       throws java.lang.Exception
        This method cancel the current shopping cart.
        Parameters:
        businessContext - the business context
        cbh - the callback handler
        Throws:
        java.lang.Exception - Exception

      • getPaymentInstructionsIds

        public java.lang.String[] getPaymentInstructionsIds(BusinessContextType bContext,
                                                    javax.security.auth.callback.CallbackHandler cbh,
                                                    java.lang.String expression)
                                             throws OrderException
        This method returns all the pay instructions that are related to the current order.
        Parameters:
        bContext - business context
        cbh - the cbh
        expression - the XPath expression of current shopper.
        Returns:
        a list of payment instructions id's
        Throws:
        OrderException - the order exception

      • deletePaymentInst

        public java.util.Map<java.lang.String,java.lang.Object> deletePaymentInst(java.util.Map<java.lang.String,java.lang.String> parameters,
                                                                          BusinessContextType bContext,
                                                                          javax.security.auth.callback.CallbackHandler cbh)
                                                                   throws java.lang.Exception
        Delete payment instruction.
        Parameters:
        parameters - the parameters
        bContext - the b context
        cbh - the cbh
        Returns:
        A map of String [] that contains the payment instructions
        Throws:
        java.lang.Exception - Throw an exception.

      • prepareOrder

        public java.util.Map<java.lang.String,java.lang.Object> prepareOrder(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                                     BusinessContextType bContext,
                                                                     javax.security.auth.callback.CallbackHandler cbh)
                                                              throws OrderException
        This method prepare the order to be submitted. It calculates charges, performs inventory actions, and locks the price of the order to indicate that the order can be submitted. If successful, returns current orderId that's in the shopper's cart.
        Parameters:
        parameters - the input parameter containing orderId.
        bContext - business context
        cbh - the cbh
        Returns:
        Shopper's orderId in shopping cart
        Throws:
        OrderException - the order exception

      • submitOrder

        public java.util.Map<java.lang.String,java.lang.Object> submitOrder(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                                    BusinessContextType bContext,
                                                                    javax.security.auth.callback.CallbackHandler cbh)
                                                             throws OrderException
        Submits the order to be processed.
        Parameters:
        parameters - the parameters
        bContext - business context
        cbh - the cbh
        Returns:
        A map of String [] that contains the checkout info, mainly orderId
        Throws:
        OrderException - the order exception

      • applyCoupon

        public java.util.Map<java.lang.String,java.lang.Object> applyCoupon(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                                    BusinessContextType bContext,
                                                                    javax.security.auth.callback.CallbackHandler cbh)
                                                             throws OrderException
        Apply coupon to the order.
        Parameters:
        parameters - the parameters
        bContext - business context
        cbh - the cbh
        Returns:
        A map of String [] that contains the order process information, mainly orderId
        Throws:
        OrderException - the order exception

      • removeCoupon

        public java.util.Map<java.lang.String,java.lang.Object> removeCoupon(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                                     BusinessContextType bContext,
                                                                     javax.security.auth.callback.CallbackHandler cbh)
                                                              throws OrderException
        Remove the coupon from order.
        Parameters:
        parameters - the parameters
        bContext - business context
        cbh - the cbh
        Returns:
        A map of String [] that contains the process information, mainly orderId
        Throws:
        OrderException - the order exception

      • applyPromoCode

        public java.util.Map<java.lang.String,java.lang.Object> applyPromoCode(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                                       BusinessContextType bContext,
                                                                       javax.security.auth.callback.CallbackHandler cbh)
                                                                throws OrderException
        Apply promotion code to the order.
        Parameters:
        parameters - the parameters
        bContext - business context
        cbh - the cbh
        Returns:
        A map of String [] that contains the order process information, mainly orderId
        Throws:
        OrderException - the order exception

      • removePromoCode

        public java.util.Map<java.lang.String,java.lang.Object> removePromoCode(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                                        BusinessContextType bContext,
                                                                        javax.security.auth.callback.CallbackHandler cbh)
                                                                 throws OrderException
        Remove the promotion code from order.
        Parameters:
        parameters - the parameters
        bContext - business context
        cbh - the cbh
        Returns:
        A map of String [] that contains the process information, mainly orderId
        Throws:
        OrderException - the order exception

      • convertPIRequestMap

        public static java.util.Map<java.lang.String,java.lang.Object> convertPIRequestMap(java.util.Map<java.lang.String,java.lang.Object> requestMap)
        This method converts the original request map into the map format that is accepted by BOD mapping utility. It will add a List for PaymentInstruction level and a List for protocolData if the request map does not have these levels.
        Parameters:
        requestMap - original request map
        Returns:
        converted map

      • lockOrder

        public java.util.Map<java.lang.String,java.lang.Object> lockOrder(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                                  BusinessContextType bContext,
                                                                  javax.security.auth.callback.CallbackHandler cbh)
                                                           throws OrderException
        CSR locks the order
        Parameters:
        parameters - the parameters
        bContext - business context
        cbh - the cbh
        Returns:
        A map of String [] that contains the order process information, mainly orderId
        Throws:
        OrderException - the order exception

      • unlockOrder

        public java.util.Map<java.lang.String,java.lang.Object> unlockOrder(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                                                    BusinessContextType bContext,
                                                                    javax.security.auth.callback.CallbackHandler cbh)
                                                             throws OrderException
        CSR unlocks the order.
        Parameters:
        parameters - the parameters
        bContext - business context
        cbh - the cbh
        Returns:
        A map of String [] that contains the order process information, mainly orderId
        Throws:
        OrderException - the order exception
Skip navigation links