com.ibm.commerce.rest.bod.helpers

Class ESpotDataHelper

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

  • public class ESpotDataHelper
extends java.lang.Object
    This class provides helper methods to get data for MarketingSpotData noun using MarketingFacadeConstants.

    • 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_BY_NAME_XPATH
      The XPath key to find a MarketingSpotData noun by name.

    • Constructor Summary

      Constructors 
      Constructor and Description
      ESpotDataHelper() 
      ESpotDataHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor, javax.ws.rs.core.UriInfo uriInfo)
      Instantiates a new e spot 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.
      java.util.Map<java.lang.String,java.lang.Object> getMarketingSpotData(ShowMarketingSpotDataDataAreaType dataArea)
      Gets the marketing spot data.
      ShowMarketingSpotDataDataAreaType getMarketingSpotDataAreaType(java.lang.String expression, java.lang.String accessProfile, java.util.Map<java.lang.String,java.lang.String> attrs, BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler cbh)
      This method performs a GetMarketingSpotData service request.
      javax.ws.rs.core.UriInfo getUri()
      Gets the URI of the atom feed request.
      void setUri(javax.ws.rs.core.UriInfo uri)
      Sets the URI of the atom feed request.

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

        public static final java.lang.String FIND_BY_NAME_XPATH
        The XPath key to find a MarketingSpotData noun by name.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ESpotDataHelper

        public ESpotDataHelper()

      • ESpotDataHelper

        public ESpotDataHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor,
                       javax.ws.rs.core.UriInfo uriInfo)
        Instantiates a new e spot 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

      • getMarketingSpotDataAreaType

        public ShowMarketingSpotDataDataAreaType getMarketingSpotDataAreaType(java.lang.String expression,
                                                                      java.lang.String accessProfile,
                                                                      java.util.Map<java.lang.String,java.lang.String> attrs,
                                                                      BusinessContextType businessContext,
                                                                      javax.security.auth.callback.CallbackHandler cbh)
                                                               throws MarketingSpotDataException
        This method performs a GetMarketingSpotData service request.
        Parameters:
        expression - the XPath expression.
        accessProfile - the access profile of the get expression.
        attrs - the attrs
        businessContext - the business context
        cbh - the cbh
        Returns:
        the MarketingSpotData noun.
        Throws:
        MarketingSpotDataException - the marketing spot data exception.

      • getMarketingSpotData

        public java.util.Map<java.lang.String,java.lang.Object> getMarketingSpotData(ShowMarketingSpotDataDataAreaType dataArea)
        Gets the marketing spot data.
        Parameters:
        dataArea - the data area
        Returns:
        the marketing spot data

      • getUri

        public javax.ws.rs.core.UriInfo getUri()
        Gets the URI of the atom feed request.
        Returns:
        the uri

      • setUri

        public void setUri(javax.ws.rs.core.UriInfo uri)
        Sets the URI of the atom feed request.
        Parameters:
        uri -
Skip navigation links