com.ibm.commerce.rest.bod.helpers

Class SpotHelper

java.lang.Object

com.ibm.commerce.rest.bod.helpers.SpotHelper

public class SpotHelper
extends java.lang.Object

This class is a helper utility class for ¨@link SpotHandlerÇ 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	FIND_BY_ID_XPATH The XPATH expression, used to retrieve Spots based on the id.
static java.lang.String	FIND_BY_NAME_XPATH The XPATH expression, used to retrieve a Spot by usage and name.
static java.lang.String	FIND_BY_USAGE_XPATH The XPATH expression, used to retrieve Spots based on usage.

Constructor Summary

Constructors

Constructor and Description
SpotHelper() Constructor for this.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessProfile() This method returns the access profile for the OAGIS service call.
commonj.sdo.DataObject	getSpot(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler, java.lang.String expression, java.lang.String accessProfile, int pageNumber, int pageSize) This method retrieves the marketing 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

FIND_BY_ID_XPATH

public static final java.lang.String FIND_BY_ID_XPATH

The XPATH expression, used to retrieve Spots based on the id.

See Also:

Constant Field Values

FIND_BY_USAGE_XPATH

public static final java.lang.String FIND_BY_USAGE_XPATH

The XPATH expression, used to retrieve Spots based on usage.

See Also:

Constant Field Values

FIND_BY_NAME_XPATH

public static final java.lang.String FIND_BY_NAME_XPATH

The XPATH expression, used to retrieve a Spot by usage and name.

See Also:

Constant Field Values

Constructor Detail

SpotHelper

public SpotHelper()

Constructor for this.

Method Detail

getSpot

public commonj.sdo.DataObject getSpot(BusinessContextType businessContext,
                                      javax.security.auth.callback.CallbackHandler callbackHandler,
                                      java.lang.String expression,
                                      java.lang.String accessProfile,
                                      int pageNumber,
                                      int pageSize)
                               throws MarketingSpotException

This method retrieves the marketing details for the specified expression.

Parameters:

businessContext - The business context. Cannot be null.

callbackHandler - The callback handler. Cannot be null.

expression - The XPath expression of the request. Cannot be null or empty.

accessProfile - The access profile of the request. Cannot be null or empty.

pageNumber - The 0-based index of the page of results to retrieve. This value must be > = 0.

pageSize - The number of results to return per page. This value must be > = 1.

Returns:

The data object for the marketing spot. This value will not be null.

Throws:

MarketingSpotException - If an error occurs when using the marketing spot web service.

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. This value will not be null or empty.