com.ibm.commerce.rest.bod.helpers

Class PromotionHelper

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


  • public class PromotionHelper
    extends java.lang.Object
    This class provides helper methods to get data for Promotion noun.
    • 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 DEFAULT_EXPRESSION
      The default expression, used to retrieve promotion.
      static java.lang.String FIND_BY_ID_EXPRESSION
      The expression to find promotion by id.
      static java.lang.String FIND_BY_NAME_EXPRESSION
      The expression to find promotion by name.
    • Constructor Summary

      Constructors 
      Constructor and Description
      PromotionHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor, javax.ws.rs.core.UriInfo uriInfo)
      Instantiates a new promotion data helper.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.rest.utils.Instrumentor getInstrumentor()
      Get the instrumentor associated with this request instance.
      commonj.sdo.DataObject getPromotion(BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh, java.lang.String expression, java.lang.String accessProfile, java.lang.String dataLanguageIds, int pageNumber, int pageSize)
      This method performs a GetPromotion service request and returns DataObject for DataArea.
      commonj.sdo.DataObject getPromotion(BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh, java.lang.String expression, java.lang.String accessProfile, java.lang.String dataLanguageIds, java.util.Map<java.lang.String,java.lang.String> ctrlParams, int pageNumber, int pageSize)
      This method performs a GetPromotion service request and returns DataObject for DataArea.
      • 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
      • DEFAULT_EXPRESSION

        public static final java.lang.String DEFAULT_EXPRESSION
        The default expression, used to retrieve promotion.
        See Also:
        Constant Field Values
      • FIND_BY_NAME_EXPRESSION

        public static final java.lang.String FIND_BY_NAME_EXPRESSION
        The expression to find promotion by name.
        See Also:
        Constant Field Values
      • FIND_BY_ID_EXPRESSION

        public static final java.lang.String FIND_BY_ID_EXPRESSION
        The expression to find promotion by id.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PromotionHelper

        public PromotionHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor,
                               javax.ws.rs.core.UriInfo uriInfo)
        Instantiates a new promotion data helper.
        Parameters:
        instrumentor - the instrumentor
        uriInfo - the uri info
    • Method Detail

      • getInstrumentor

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

        public commonj.sdo.DataObject getPromotion(BusinessContextType bContext,
                                                   javax.security.auth.callback.CallbackHandler cbh,
                                                   java.lang.String expression,
                                                   java.lang.String accessProfile,
                                                   java.lang.String dataLanguageIds,
                                                   int pageNumber,
                                                   int pageSize)
                                            throws PromotionException
        This method performs a GetPromotion service request and returns DataObject for DataArea.
        Parameters:
        bContext - the business context.
        cbh - the call back handler.
        expression - the expression.
        accessProfile - the access profile.
        dataLanguageIds - the data language ids.
        pageNumber - the page number.
        pageSize - the page size
        Returns:
        the Promotion noun.
        Throws:
        PromotionException - the exception representing the error of the GetPromotion request.
      • getPromotion

        public commonj.sdo.DataObject getPromotion(BusinessContextType bContext,
                                                   javax.security.auth.callback.CallbackHandler cbh,
                                                   java.lang.String expression,
                                                   java.lang.String accessProfile,
                                                   java.lang.String dataLanguageIds,
                                                   java.util.Map<java.lang.String,java.lang.String> ctrlParams,
                                                   int pageNumber,
                                                   int pageSize)
                                            throws PromotionException
        This method performs a GetPromotion service request and returns DataObject for DataArea.
        Parameters:
        bContext - the business context.
        cbh - the call back handler.
        expression - the expression.
        accessProfile - the access profile.
        dataLanguageIds - the data language ids.
        ctrlParams - the optional name-value pair control parameters.
        pageNumber - the page number.
        pageSize - the page size
        Returns:
        the Promotion noun.
        Throws:
        PromotionException - the exception representing the error of the GetPromotion request.