public class SpotHelper
extends java.lang.Object
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 and Description |
---|
SpotHelper()
Constructor for this.
|
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.
|
public static final java.lang.String DEFAULT_ACCESS_PROFILE
accessProfile
query parameter.public static final java.lang.String FIND_BY_ID_XPATH
public static final java.lang.String FIND_BY_USAGE_XPATH
public static final java.lang.String FIND_BY_NAME_XPATH
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
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.MarketingSpotException
- If an error occurs when using the marketing spot web service.public java.lang.String getAccessProfile()