public class PromotionHelper
extends java.lang.Object
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 and Description |
---|
PromotionHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor,
javax.ws.rs.core.UriInfo uriInfo)
Instantiates a new promotion data helper.
|
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. |
public static final java.lang.String COPYRIGHT
public static final java.lang.String DEFAULT_ACCESS_PROFILE
accessProfile
query parameter.public static final java.lang.String DEFAULT_EXPRESSION
public static final java.lang.String FIND_BY_NAME_EXPRESSION
public static final java.lang.String FIND_BY_ID_EXPRESSION
public PromotionHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor, javax.ws.rs.core.UriInfo uriInfo)
instrumentor
- the instrumentoruriInfo
- the uri infopublic com.ibm.commerce.rest.utils.Instrumentor getInstrumentor()
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
GetPromotion
service request and returns
DataObject for DataArea.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 sizePromotionException
- the exception representing the error of the
GetPromotion request.
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
GetPromotion
service request and returns
DataObject for DataArea.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 sizePromotionException
- the exception representing the error of the
GetPromotion request.