com.ibm.commerce.rest.bod.helpers

Class PriceHelper

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


  • public class PriceHelper
    extends java.lang.Object
    The PriceHelper is a helper utility class for PriceHandler to make the OAGIS calls and get the data area for constructing the response.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      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 DISPLAY_PRICE_XPATH_START
      The start of the XPath for all display price web service calls.
      static java.lang.String XPATH_START
      The start of the XPath for all entitled price web service calls.
    • Constructor Summary

      Constructors 
      Constructor and Description
      PriceHelper() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getAccessProfile()
      This method returns the access profile for the OAGIS service call.
      commonj.sdo.DataObject getPrice(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler, java.lang.String expression, java.lang.String accessProfile)
      This method retrieves the price details for the specified expression.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

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

        public static final java.lang.String XPATH_START
        The start of the XPath for all entitled price web service calls.
        See Also:
        Constant Field Values
      • DISPLAY_PRICE_XPATH_START

        public static final java.lang.String DISPLAY_PRICE_XPATH_START
        The start of the XPath for all display price web service calls.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PriceHelper

        public PriceHelper()
    • Method Detail

      • getPrice

        public commonj.sdo.DataObject getPrice(BusinessContextType businessContext,
                                               javax.security.auth.callback.CallbackHandler callbackHandler,
                                               java.lang.String expression,
                                               java.lang.String accessProfile)
                                        throws com.ibm.commerce.price.facade.client.EntitledPriceException
        This method retrieves the price details for the specified expression.
        Parameters:
        businessContext - the business context.
        callbackHandler - the callback handler.
        expression - the XPath expression.
        accessProfile - the specified access profile.
        Returns:
        the data object for the price.
        Throws:
        com.ibm.commerce.price.facade.client.EntitledPriceException - the price exception
      • getAccessProfile

        public java.lang.String getAccessProfile()
        This method returns the access profile for the OAGIS service call. This method can be overridden to change the access profile.
        Returns:
        the access profile