com.ibm.commerce.rest.bod.helpers

Class WishlistHelper

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

  • public class WishlistHelper
extends java.lang.Object
    This class provides helper methods to get and update data for GiftList noun using GiftCenterFacadeClient.

    • Constructor Summary

      Constructors 
      Constructor and Description
      WishlistHelper() 
      WishlistHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor)
      Instantiates a new wish list helper.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Map<java.lang.String,java.lang.Object> changeWishlist(java.util.Map<java.lang.String,java.lang.Object> requestMap, java.lang.String resourceName, java.lang.String urlParamGrpName, java.lang.String actionCode, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      Change wishlist.
      com.ibm.commerce.rest.utils.Instrumentor getInstrumentor()
      Get the instrumentor associated with this request instance.
      ShowGiftListDataAreaType getWishlist(BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh, java.lang.String expression, java.lang.String accessProfile)
      This method performs a GetWishlist service request.
      ShowGiftListDataAreaType getWishlist(BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh, java.lang.String expression, java.lang.String accessProfile, java.lang.Long recordStartNumber, java.lang.Long maxItems)
      This method performs a GetWishlist service request with paging support.
      java.util.Map<java.lang.String,java.lang.Object> processWishlist(java.util.Map<java.lang.String,java.lang.Object> requestMap, java.lang.String resourceName, java.lang.String urlParamGrpName, java.lang.String actionCode, BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh)
      Process wishlist.

      • 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, used when an access profile is not specified using the accessProfile query parameter.
        See Also:
        Constant Field Values

      • FIND_BY_EXTERNALID_XPATH

        public static final java.lang.String FIND_BY_EXTERNALID_XPATH
        The XPath key to find a GiftList noun by externaId.
        See Also:
        Constant Field Values

      • FIND_BY_EXTERNALID_XPATH2

        public static final java.lang.String FIND_BY_EXTERNALID_XPATH2
        The Constant FIND_BY_EXTERNALID_XPATH2.
        See Also:
        Constant Field Values

      • FIND_ITEMS_BY_EXTERNALID_XPATH

        public static final java.lang.String FIND_ITEMS_BY_EXTERNALID_XPATH
        The XPath key to find a GiftList items noun part by externaId.
        See Also:
        Constant Field Values

      • FIND_ITEMS_BY_EXTERNALID_XPATH2

        public static final java.lang.String FIND_ITEMS_BY_EXTERNALID_XPATH2
        The Constant FIND_BY_EXTERNALID_XPATH2.
        See Also:
        Constant Field Values

      • FIND_BY_USERID_DEFAULT_XPATH

        public static final java.lang.String FIND_BY_USERID_DEFAULT_XPATH
        The Constant FIND_BY_UserId_default_XPATH.
        See Also:
        Constant Field Values

      • FIND_BY_USERID_XPATH

        public static final java.lang.String FIND_BY_USERID_XPATH
        The Constant FIND_BY_UserId_XPATH.
        See Also:
        Constant Field Values

    • Constructor Detail

      • WishlistHelper

        public WishlistHelper()

      • WishlistHelper

        public WishlistHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor)
        Instantiates a new wish list 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

      • getWishlist

        public ShowGiftListDataAreaType getWishlist(BusinessContextType bContext,
                                            javax.security.auth.callback.CallbackHandler cbh,
                                            java.lang.String expression,
                                            java.lang.String accessProfile)
                                     throws GiftCenterException
        This method performs a GetWishlist service request.
        Parameters:
        bContext - the b context
        cbh - the cbh
        expression - the XPath expression.
        accessProfile - the access profile of the get expression.
        Returns:
        the GiftList noun.
        Throws:
        GiftCenterException - the exception representing the error of the GetWishlist request.

      • getWishlist

        public ShowGiftListDataAreaType getWishlist(BusinessContextType bContext,
                                            javax.security.auth.callback.CallbackHandler cbh,
                                            java.lang.String expression,
                                            java.lang.String accessProfile,
                                            java.lang.Long recordStartNumber,
                                            java.lang.Long maxItems)
                                     throws GiftCenterException
        This method performs a GetWishlist service request with paging support.
        Parameters:
        bContext - the b context
        cbh - the cbh
        expression - the XPath expression.
        accessProfile - the access profile of the get expression.
        recordStartNumber - the record start number.
        maxItems - the maximum number of items to return.
        Returns:
        the GiftList noun.
        Throws:
        GiftCenterException - the exception representing the error of the GetWishlist request.

      • processWishlist

        public java.util.Map<java.lang.String,java.lang.Object> processWishlist(java.util.Map<java.lang.String,java.lang.Object> requestMap,
                                                                        java.lang.String resourceName,
                                                                        java.lang.String urlParamGrpName,
                                                                        java.lang.String actionCode,
                                                                        BusinessContextType bContext,
                                                                        javax.security.auth.callback.CallbackHandler cbh)
                                                                 throws java.lang.Exception
        Process wishlist.
        Parameters:
        requestMap - the request map
        resourceName - the resource name
        urlParamGrpName - the url param grp name
        actionCode - the action code
        bContext - the b context
        cbh - the cbh
        Returns:
        the acknowledge gift list data area type
        Throws:
        java.lang.Exception - the exception

      • changeWishlist

        public java.util.Map<java.lang.String,java.lang.Object> changeWishlist(java.util.Map<java.lang.String,java.lang.Object> requestMap,
                                                                       java.lang.String resourceName,
                                                                       java.lang.String urlParamGrpName,
                                                                       java.lang.String actionCode,
                                                                       BusinessContextType bContext,
                                                                       javax.security.auth.callback.CallbackHandler cbh)
                                                                throws java.lang.Exception
        Change wishlist.
        Parameters:
        requestMap - the request map
        resourceName - the resource name
        urlParamGrpName - the url param grp name
        actionCode - the action code
        bContext - the b context
        cbh - the cbh
        Returns:
        the acknowledge gift list data area type
        Throws:
        java.lang.Exception - the exception
Skip navigation links