com.ibm.commerce.rest.bod.helpers

Class SegmentHelper

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

  • public class SegmentHelper
extends java.lang.Object
    This class provides helper methods to get customer segment handler

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright notice field.
      static java.lang.String DEFAULT_ACCESS_PROFILE
      The default access profile, used when an access profile is not specified using the accessProfile query parameter.
      static java.lang.String FIND_ALL_BY_STOREID_XPATH
      The XPath key to find all customer segment noun by storeId.
      static java.lang.String FIND_BY_BY_USER_ID
      The XPath key to search customer segment based on user and usage
      static java.lang.String FIND_BY_NAME_XPATH
      The XPath key to search customer segment noun by name.
      static java.lang.String FIND_BY_SEGMENT_ID_AND_UNIQUE_ID
      The XPath key to check if specific user is in the customer segment
      static java.lang.String FIND_BY_UNIQUE_ID
      The XPath key to search customer segment by id

    • Constructor Summary

      Constructors 
      Constructor and Description
      SegmentHelper() 
      SegmentHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor)
      Instantiates a new customer segment helper.

    • 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_ALL_BY_STOREID_XPATH

        public static final java.lang.String FIND_ALL_BY_STOREID_XPATH
        The XPath key to find all customer segment noun by storeId.
        See Also:
        Constant Field Values

      • FIND_BY_NAME_XPATH

        public static final java.lang.String FIND_BY_NAME_XPATH
        The XPath key to search customer segment noun by name.
        See Also:
        Constant Field Values

      • FIND_BY_UNIQUE_ID

        public static final java.lang.String FIND_BY_UNIQUE_ID
        The XPath key to search customer segment by id
        See Also:
        Constant Field Values

      • FIND_BY_SEGMENT_ID_AND_UNIQUE_ID

        public static final java.lang.String FIND_BY_SEGMENT_ID_AND_UNIQUE_ID
        The XPath key to check if specific user is in the customer segment
        See Also:
        Constant Field Values

      • FIND_BY_BY_USER_ID

        public static final java.lang.String FIND_BY_BY_USER_ID
        The XPath key to search customer segment based on user and usage
        See Also:
        Constant Field Values

    • Constructor Detail

      • SegmentHelper

        public SegmentHelper()

      • SegmentHelper

        public SegmentHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor)
        Instantiates a new customer segment 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

      • getCustomerSegmentByPersonalizationId

        public ShowMemberGroupDataAreaType getCustomerSegmentByPersonalizationId(java.lang.String personalizationId,
                                                                         BusinessContextType bContext,
                                                                         javax.security.auth.callback.CallbackHandler cbh,
                                                                         java.lang.String accessProfile)
        The method get customer segment by specific peronalizationId
        Parameters:
        personalizationId - personalization ID
        bContext - the b context
        cbh - the cbh
        accessProfile - the access profile of the get expression.
        Returns:
        the memberGroup Noun.

      • checkCustomerSegmentByPersonalizatoinId

        public boolean checkCustomerSegmentByPersonalizatoinId(java.lang.String personalizationId,
                                                       java.lang.String segmentId,
                                                       java.lang.String accessProfile)
        The method check if given personalizationId is in specific customer segment
        Parameters:
        personalizationId - personalizationId
        segmentId - segmentId
        accessProfile - accessProfile
        Returns:
        the boolean result

      • getCustomerSegment

        public ShowMemberGroupDataAreaType getCustomerSegment(int pageNumber,
                                                      int pageSize,
                                                      BusinessContextType bContext,
                                                      javax.security.auth.callback.CallbackHandler cbh,
                                                      java.lang.String expression,
                                                      java.lang.String accessProfile)
                                               throws MemberGroupException
        This method performs a getCustomerSegment service request.
        Parameters:
        pageNumber -
        pageSize -
        bContext -
        cbh -
        expression -
        accessProfile -
        Returns:
        Member Group Noun
        Throws:
        MemberGroupException
Skip navigation links