Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  the IBM Copyright notice field.

  See Also:

  Constant Field Values

• _STR_ORD_ID

  public static final java.lang.String _STR_ORD_ID
  

  The order Id parameter.

  See Also:

  OrderFacadeConstants.STR_ORD_ID, Constant Field Values

• _STR_ORD_STATUS

  public static final java.lang.String _STR_ORD_STATUS
  

  The order status.

  See Also:

  OrderFacadeConstants.STR_ORD_STATUS, Constant Field Values

• _STR_ACCESS_PROFILE

  public static final java.lang.String _STR_ACCESS_PROFILE
  

  The access profile.

  See Also:

  OrderFacadeConstants.STR_ACCESS_PROFILE, Constant Field Values

• ACCESS_PROFILE

  public static final java.lang.String ACCESS_PROFILE
  

  The access profile search parameter.

  See Also:

  Constant Field Values

• IBM_SUMMARY

  public static final java.lang.String IBM_SUMMARY
  

  The string of Order summary.

  See Also:

  OrderFacadeConstants.IBM_SUMMARY, Constant Field Values

• IBM_DETAILS

  public static final java.lang.String IBM_DETAILS
  

  The string of Order details.

  See Also:

  OrderFacadeConstants.IBM_DETAILS, Constant Field Values

• IBM_USABLESHIPPINGINFO

  public static final java.lang.String IBM_USABLESHIPPINGINFO
  

  The string of Order usable shipping information.

  See Also:

  OrderFacadeConstants.IBM_USABLESHIPPINGINFO, Constant Field Values

• IBM_USABLEPAYMENTINFO

  public static final java.lang.String IBM_USABLEPAYMENTINFO
  

  The string of Order usable payment information.

  See Also:

  OrderFacadeConstants.IBM_USABLEPAYMENTINFO, Constant Field Values

Constructor Detail

• GetOrderExpressionBuilder

  public GetOrderExpressionBuilder()
  

Method Detail

• findOrderByStoreMemberAndPlacedDate

  public ExpressionType findOrderByStoreMemberAndPlacedDate(java.util.Map amNVPs)
  

  Forms an expression to query orders by store ID, member IDs and placed date.

  The following parameters are expected:

    name (key)                                                      value
    OrderFacadeConstants.STR_ACCESS_PROFILE                 array of access profiles
    OrderFacadeConstants.STR_ORD_STATUS                     array of order statuses
    OrderFacadeConstants.STORE_ID                           store ID
    OrderFacadeConstants.MEMBER_ID                          array of member IDs
    OrderFacadeConstants.STR_DATA_LANG_IDS                  array of size one with language id
    OrderFacadeConstants.CONTROL_PARAMETER_DISPLAY_CURRENCY the currency used to display the order amount
    OrderFacadeConstants.START_PLACED_DATE                  the start of order placed date
    OrderFacadeConstants.END_PLACED_DATE                    the end of order placed date
   
  

  Parameters:

  amNVPs - the parameters used to build the expression. Cannot be null.

  Returns:

  a query expression of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findQuoteByStoreMemberAndPlacedDate

  public ExpressionType findQuoteByStoreMemberAndPlacedDate(java.util.Map amNVPs)
  

  Forms an expression to query quotes by store ID, member IDs and placed date.

  The following parameters are expected:

    name (key)                                                      value
    OrderFacadeConstants.STR_ACCESS_PROFILE                 array of access profiles
    OrderFacadeConstants.STORE_ID                           store ID
    OrderFacadeConstants.MEMBER_ID                          array of member IDs
    OrderFacadeConstants.STR_ORD_STATUS                     array of order statuses
    OrderFacadeConstants.STR_DATA_LANG_IDS                  array of size one with language id
    OrderFacadeConstants.CONTROL_PARAMETER_DISPLAY_CURRENCY the currency used to display the order amount
    OrderFacadeConstants.START_PLACED_DATE                  the start of order placed date
    OrderFacadeConstants.END_PLACED_DATE                    the end of order placed date
   
  

  Parameters:

  amNVPs - the parameters used to build the expression. Cannot be null.

  Returns:

  a query expression of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findExternalOrdersByStoreMemberAndStatus

  public ExpressionType findExternalOrdersByStoreMemberAndStatus(java.util.Map amNVPs)
  

  Forms an expression to query external orders by store name, member DNs and order statuses.

  The following parameters are expected:

    name (key)                                                      value
    OrderFacadeConstants.STR_ACCESS_PROFILE                 array of access profiles
    OrderFacadeConstants.STORE_NAME                         store name
    OrderFacadeConstants.MEMBER_DN                          array of member DNs
    OrderFacadeConstants.STR_DATA_LANG_IDS                  array of size one with language id
    OrderFacadeConstants.STR_ORD_STATUS                     array of order status
   
  

  Parameters:

  amNVPs - the parameters used to build the expression. Cannot be null.

  Returns:

  a query expression of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findExternalQuotesByStoreMemberAndStatus

  public ExpressionType findExternalQuotesByStoreMemberAndStatus(java.util.Map amNVPs)
  

  Forms an expression to query external quotes by store name, member DNs and order statuses.

  The following parameters are expected:

    name (key)                                                      value
    OrderFacadeConstants.STR_ACCESS_PROFILE                 array of access profiles
    OrderFacadeConstants.STORE_NAME                         store name
    OrderFacadeConstants.MEMBER_DN                          array of member DNs
    OrderFacadeConstants.STR_DATA_LANG_IDS                  array of size one with language id
    OrderFacadeConstants.STR_ORD_STATUS                     array of order status
   
  

  Parameters:

  amNVPs - the parameters used to build the expression. Cannot be null.

  Returns:

  a query expression of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findOrderByExternalIdAndStoreName

  public ExpressionType findOrderByExternalIdAndStoreName(java.util.Map amNVPs)
  

  Forms an expression to query order by external order id and store name.

  The following parameters are expected:

    name (key)                                                      value
    OrderFacadeConstants.STR_ACCESS_PROFILE                 array of access profiles
    OrderFacadeConstants.STORE_NAME                         store name
    OrderFacadeConstants.STR_DATA_LANG_IDS                  array of size one with language id
    OrderFacadeConstants.STR_EXT_ORD_ID                     external order id
   
  

  Parameters:

  amNVPs - the parameters used to build the expression. Cannot be null.

  Returns:

  a query expression of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findQuoteByExternalIdAndStoreName

  public ExpressionType findQuoteByExternalIdAndStoreName(java.util.Map amNVPs)
  

  Forms an expression to query quote by external quote id and store name.

  The following parameters are expected:

    name (key)                                                      value
    OrderFacadeConstants.STR_ACCESS_PROFILE                 array of access profiles
    OrderFacadeConstants.STORE_NAME                         store name
    OrderFacadeConstants.STR_DATA_LANG_IDS                  array of size one with language id
    OrderFacadeConstants.STR_EXT_QOT_ID                     external quote id
   
  

  Parameters:

  amNVPs - the parameters used to build the expression. Cannot be null.

  Returns:

  a query expression of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findOrderItemByStoreMemberAndCreateDate

  public ExpressionType findOrderItemByStoreMemberAndCreateDate(java.util.Map amNVPs)
  

  Forms an expression to query order items by store ID, member IDs and create date.

  The following parameters are expected:

    name (key)                                                      value
    OrderFacadeConstants.STR_ACCESS_PROFILE                 array of access profiles
    OrderFacadeConstants.ORDER_ITEM_STATUS                  array of order item statuses
    OrderFacadeConstants.STORE_ID                           store ID
    OrderFacadeConstants.MEMBER_ID                          array of member IDs
    OrderFacadeConstants.STR_DATA_LANG_IDS                  array of size one with language id
    OrderFacadeConstants.CONTROL_PARAMETER_DISPLAY_CURRENCY the currency used to display the order amount
    OrderFacadeConstants.START_CREATE_DATE                  the start of order item create date
    OrderFacadeConstants.END_CREATE_DATE                    the end of order item create date
   
  

  Parameters:

  amNVPs - the parameters used to build the expression. Cannot be null.

  Returns:

  a query expression of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findByOrderStatus

  public ExpressionType findByOrderStatus(java.util.Map amNVPs)
  

  Forms an expression to query orders by status.

  The following values are expected:

    name (key)                                      value
    _STR_ORD_STATUS                        array of order statuses
    _STR_ACCESS_PROFILE                    array of size one with access profile
    OrderFacadeConstants.STR_DATA_LANG_IDS  array of size one with language id
   
  

  Parameters:

  amNVPs - Map which maps names of type String to values of type String[]. Cannot be null.

  Returns:

  List of query expressions of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findQuotesByStatus

  public ExpressionType findQuotesByStatus(java.util.Map amNVPs)
  

  Forms an expression to query quotes by status.

  The following values are expected:

    name (key)                                      value
    _STR_ORD_STATUS                        array of order statuses
    _STR_ACCESS_PROFILE                    array of size one with access profile
    OrderFacadeConstants.STR_DATA_LANG_IDS  array of size one with language id
   
  

  Parameters:

  amNVPs - Map which maps names of type String to values of type String[]. Cannot be null.

  Returns:

  List of query expressions of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findByOrderId

  public ExpressionType findByOrderId(java.util.Map amNVPs)
  

  Forms an expression to query orders by Id. The following values are expected:

    name (key)                                      value
    _STR_ORD_ID                            array of size one with the order id
    _STR_ACCESS_PROFILE                    array of size one with access profile
    OrderFacadeConstants.STR_DATA_LANG_IDS  array of size one with language id
    OrderFacadeConstants.PAGING_ON          the paging parameter (optional)
   
  

  Parameters:

  amNVPs - Map which maps names of type String to values of type String[]. Cannot be null.

  Returns:

  List of query expressions of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findCurrentShoppingCart

  public ExpressionType findCurrentShoppingCart(java.util.Map amNVPs)
  

  This method is used to form an expression to query current shopping cart. Using this expression, the order items will be sorted by the shipping address identifier.

  The following values are expected:

    name (key)                                      value
    _STR_ACCESS_PROFILE                    array of size one with access profile
    OrderFacadeConstants.STR_DATA_LANG_IDS  array of size one with language id
    OrderFacadeConstants.PAGING_ON          the paging parameter (optional)
   
  

  Parameters:

  amNVPs - Map which maps names of type String to values of type String[]. Cannot be null.

  Returns:

  List of query expressions of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findCurrentShoppingCart

  public ExpressionType findCurrentShoppingCart(java.util.Map amNVPs,
                                       java.lang.String sortOrderItemBy)
  

  This method is used to form an expression to query current shopping cart .

  The following values are expected:

    name (key)                                      value
    _STR_ACCESS_PROFILE                    array of size one with access profile
    OrderFacadeConstants.STR_DATA_LANG_IDS  array of size one with language id
    OrderFacadeConstants.PAGING_ON          the paging parameter (optional)
   
  

  Parameters:

  amNVPs - Map which maps names of type String to values of type String[]. Cannot be null.

  sortOrderItemBy - This parameter is used to sort the order items. If no value passed for it, the order items will be sorted by the shipping address identifier. Possible values: "orderItemID" indicates that the order items in the order will be sorted by the order item identifier. Currently, only "orderItemID" is supported.

  Returns:

  List of query expressions of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findScheduledOrder

  public ExpressionType findScheduledOrder(java.util.Map amNVPs)
  

  Forms an expression to query scheduled orders by storeId, member id and start time. The following values are expected:

    name (key)                                      value
    _STR_ACCESS_PROFILE                                                array of size one with access profile
    OrderFacadeConstants.STORE_ID                                        store ID
    OrderFacadeConstants.MEMBER_ID                                        member ID
    OrderFacadeConstants.ORDER_SCHEDULE_START_TIME          the start time of scheduled order (optional)
   
  

  Parameters:

  amNVPs - Map which maps names of type String to values of type String[]. Cannot be null.

  Returns:

  the query expression of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findByExternalOrderId

  public ExpressionType findByExternalOrderId(java.util.Map amNVPs)
  

  Forms an expression to query orders by Id .

  Parameters:

  amNVPs - Map which maps names of type String to values of type String[]. The following values are expected:

                            name (key)               value
                            orderId               array of order Ids
                            AccessProfile         access profile
                          
  

  Returns:

  List of query expressions of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findByExternalQuoteId

  public ExpressionType findByExternalQuoteId(java.util.Map amNVPs)
  

  This is the out bound service to get quote detail by id. Forms an expression to query quotes by Id .

  Parameters:

  amNVPs - Map which maps names of type String to values of type String[]. The following values are expected:

                            name (key)               value
                            orderId               array of quote Ids
                            ibmwcf                array of size one with access profile
                          
  

  Returns:

  List of query expressions of com.ibm.commerce.oagis9.datatypes.ExpressionType type.

• findConfigurationByOrderItemId

  public ExpressionType findConfigurationByOrderItemId(java.util.Map amNVPs)
  

  This method forms an expression to query order item configuration by order item id.

  Parameters:

  amNVPs - Map which maps names of type String to values of type String[]. This should be null.

  The following values are expected:

    name (key)                                                        value
    OrderFacadeConstants.ORDERITEM_ID                    array of size one with order item id
    OrderFacadeConstants.STR_ACCESS_PROFILE              array of size one with access profile
   
  

  Returns:

  The query expression