com.ibm.commerce.rest.marketing.handler

Class PromotionHandler

java.lang.Object

com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

com.ibm.commerce.rest.marketing.handler.PromotionHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/promotion")
 @Encoded
public class PromotionHandler
extends AbstractResourceHandler

This class converts RESTful Promotion requests into WebSphere Commerce Promotion requests and returns data in JSON format.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	FORMAT_GROUP_NAME The constant FORMAT_GROUP_NAME.
static java.lang.String	RESOURCE_MAPPING_KEY The Constant RESOURCE_MAPPING_KEY.
static java.lang.String	RESOURCE_NAME The Constant RESOURCE_NAME.

Fields inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

APPLICATION_ATOM_XML, APPLICATION_JSON, APPLICATION_XHTML_XML, APPLICATION_XML, CHANGE_VERB, PARAMETER_ACTION, PARAMETER_ACTION_DESCRIPTION, PARAMETER_CATALOG_ID, PARAMETER_CATALOG_ID_DESCRIPTION, PARAMETER_CURRENCY, PARAMETER_CURRENCY_DESCRIPTION, PARAMETER_FOR_USER, PARAMETER_FOR_USER_DESCRIPTION, PARAMETER_FOR_USER_ID, PARAMETER_FOR_USER_ID_DESCRIPTION, PARAMETER_LANG_ID, PARAMETER_LANG_ID_DESCRIPTION, PARAMETER_LOCALE, PARAMETER_LOCALE_DESCRIPTION, PARAMETER_MODE, PARAMETER_MODE_DESCRIPTION, PARAMETER_PAGE_NUMBER, PARAMETER_PAGE_NUMBER_DESCRIPTION, PARAMETER_PAGE_SIZE, PARAMETER_PAGE_SIZE_DESCRIPTION, PARAMETER_PROFILE_NAME, PARAMETER_PROFILE_NAME_DESCRIPTION, PARAMETER_QUERY, PARAMETER_QUERY_DESCRIPTION, PARAMETER_RESET_PASSWORD_DESCRIPTION, PARAMETER_RESPONSE_FORMAT, PARAMETER_RESPONSE_FORMAT_DESCRIPTION, PARAMETER_STORE_ID, PARAMETER_STORE_ID_DESCRIPTION, PARAMETER_WORKSPACE_IDENTIFIER, PARAMETER_WORKSPACE_IDENTIFIER_DESCRIPTION, PARAMETER_WORKSPACE_NAME, PARAMETER_WORKSPACE_NAME_DESCRIPTION, PARAMETER_WORKSPACE_TASK, PARAMETER_WORKSPACE_TASK_DESCRIPTION, PARAMETER_WORKSPACE_TASKGROUP, PARAMETER_WORKSPACE_TASKGROUP_DESCRIPTION, PROCESS_VERB, RESPONSE_200_DESCRIPTION, RESPONSE_201_DESCRIPTION, RESPONSE_204_DESCRIPTION, RESPONSE_400_DESCRIPTION, RESPONSE_401_DESCRIPTION, RESPONSE_403_DESCRIPTION, RESPONSE_404_DESCRIPTION, RESPONSE_500_DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
PromotionHandler()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormattingGroupName() This method returns the format group name to locate JSP template.
PromotionHelper	getHelper() Return the BOD helper associated with the eSpot resource.
javax.ws.rs.core.Response	getPromotionByID(java.lang.String storeId, int promotionId, java.lang.String langId, java.lang.String responseFormat) This method gets the promotion by promotion id.
javax.ws.rs.core.Response	getPromotionsByQuery(java.lang.String storeId, java.lang.String langId, java.lang.String q, java.lang.String name, java.lang.String responseFormat, int pageNumber, int pageSize) This method gets promotion list for the store.
java.lang.String	getResourceName() This method returns the resource name.
javax.ws.rs.core.UriInfo	getUri() Get the URI of the atom feed request.
void	postProcess(java.util.Map<java.lang.String,java.lang.Object> responseMap) Method to provide post process in out of box JSON/XML entity providers after each DataObject has been converted to a Map and before constructing the REST response.

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

createMapForProvider, createMapForProvider, generateResponseForEntireDataObject, getMapFromRequest, getStoreId, getUserId, isRequestInPreviewMode, mergeMapsForProvider, prepareAndValidate

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

addError, createMapForProviderWithResultData, documentApi, generateResponseFromHttpStatusCodeAndRespData, getActionRegistry, getBooleanParameterValue, getClassDescription, getDoubleParameterValue, getDoubleParameterValues, getEnumeratedParameterValue, getErrorCodeFromMessage, getExternalResourceName, getFormattedMessage, getFormattedMessageWithLocale, getInstrumentor, getIntegerParameterValue, getIntegerParameterValues, getLongParameterValue, getLongParameterValues, getParameterValue, getParameterValue, getParameterValues, getQueryRegistry, getRequest, getResponse, getUriInfo, handleException, initializeActionRegistry, initializeQueryRegistry, performAction, preProcess, registerOperationWithMethodSignature, runQuery, staticConvertStreamToString, throwInvalidQueryNameException, throwInvalidQueryNameException, throwRestException, throwRestExceptionIfErrorsAreDetected, validatePageNumberPageSize

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

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

The Constant RESOURCE_NAME.

See Also:

Constant Field Values

RESOURCE_MAPPING_KEY

public static final java.lang.String RESOURCE_MAPPING_KEY

The Constant RESOURCE_MAPPING_KEY.

See Also:

Constant Field Values

FORMAT_GROUP_NAME

public static final java.lang.String FORMAT_GROUP_NAME

The constant FORMAT_GROUP_NAME.

See Also:

Constant Field Values

Constructor Detail

PromotionHandler

public PromotionHandler()

Method Detail

getUri

public javax.ws.rs.core.UriInfo getUri()

Get the URI of the atom feed request.

Returns:

the uri

getResourceName

public java.lang.String getResourceName()

This method returns the resource name.

Returns:

the resource name.

getHelper

public PromotionHelper getHelper()

Return the BOD helper associated with the eSpot resource.

Returns:

PromotionHelper

getFormattingGroupName

public java.lang.String getFormattingGroupName()

This method returns the format group name to locate JSP template.

Specified by:

getFormattingGroupName in interface IResourceHandler

Overrides:

getFormattingGroupName in class AbstractBaseResourceHandler

Returns:

formatting group name

getPromotionsByQuery

@GET
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response getPromotionsByQuery(@PathParam(value="storeId")
                                                                                                                                                                   java.lang.String storeId,
                                                                                                                                                                   @QueryParam(value="langId")
                                                                                                                                                                   java.lang.String langId,
                                                                                                                                                                   @QueryParam(value="q")
                                                                                                                                                                   java.lang.String q,
                                                                                                                                                                   @QueryParam(value="qName")
                                                                                                                                                                   java.lang.String name,
                                                                                                                                                                   @QueryParam(value="responseFormat")
                                                                                                                                                                   java.lang.String responseFormat,
                                                                                                                                                                   @QueryParam(value="pageNumber")
                                                                                                                                                                   int pageNumber,
                                                                                                                                                                   @QueryParam(value="pageSize")
                                                                                                                                                                   int pageSize)

This method gets promotion list for the store. When q supplied with byName, it will perform search by name.

Parameters:

storeId - the store id.

langId - the language id.

q - query parameter.

name - name to be search.

responseFormat - the response format.

pageNumber - the page number.

pageSize - the page size.

Returns:

a collection of Promotion nouns in the specified format.

getPromotionByID

@GET
 @Path(value="{promotionId}")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response getPromotionByID(@PathParam(value="storeId")
                                                                                                                                                                                             java.lang.String storeId,
                                                                                                                                                                                             @PathParam(value="promotionId")
                                                                                                                                                                                             int promotionId,
                                                                                                                                                                                             @QueryParam(value="langId")
                                                                                                                                                                                             java.lang.String langId,
                                                                                                                                                                                             @QueryParam(value="responseFormat")
                                                                                                                                                                                             java.lang.String responseFormat)

This method gets the promotion by promotion id.

Parameters:

storeId - The store id.

promotionId - The promotion id.

langId - The language id.

responseFormat - The response format.

Returns:

The array of promotion details in the specified format.

postProcess

public void postProcess(java.util.Map<java.lang.String,java.lang.Object> responseMap)

Method to provide post process in out of box JSON/XML entity providers after each DataObject has been converted to a Map and before constructing the REST response. By default, it does nothing. Overwrite this method in your resource handler class to perform any post process, for example, merge maps from multiple DataObjects into a single Map.

Specified by:

postProcess in interface IResourceHandler

Overrides:

postProcess in class AbstractBaseResourceHandler

Parameters:

responseMap - The response Map after each DataObject has been converted to a Map.