com.ibm.commerce.rest.coupon.handler

Class CouponHandler

java.lang.Object

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

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

com.ibm.commerce.foundation.rest.resourcehandler.AbstractClassicResourceHandler

com.ibm.commerce.rest.coupon.handler.CouponHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/coupon")
 @Encoded
public class CouponHandler
extends com.ibm.commerce.foundation.rest.resourcehandler.AbstractClassicResourceHandler

This class provides RESTful services to get and process coupon information. For example, deleting a coupon from the list.

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
CouponHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteCouponById(java.lang.String storeId, java.lang.String couponId, java.lang.String responseFormat) This method deletes the coupon by coupon id.
javax.ws.rs.core.Response	getCoupon(java.lang.String storeId, java.lang.String responseFormat, int pageNumber, int pageSize) This method returns the coupon list for the current shopper.
java.lang.String	getFormattingGroupName() Returns the formatting group name for resolving the struts action of the formatting JSP.
CouponHelper	getHelper() This method returns the BOD helper associated with the Coupon resource.
java.lang.String	getResourceName() This method returns the name of the resource used primarily to determine the representation of the resource.
javax.ws.rs.core.Response	issueCoupon(java.lang.String storeId, java.lang.String responseFormat) This method is used by shopper to self-obtain a coupon.
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.
void	preProcess(java.util.Map<java.lang.String,java.lang.Object> responseMap) This method can be used to do the pre-processing of the response map before the entity provider is invoked passing the response map.

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, 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

CouponHandler

public CouponHandler()

Method Detail

getResourceName

public java.lang.String getResourceName()

Description copied from interface: IResourceHandler

This method returns the name of the resource used primarily to determine the representation of the resource. This class can be overridden to change the name of the resource and therefore the representation, while keeping all the methods in this class.

Returns:

the resource name

See Also:

IResourceHandler.getResourceName()

getFormattingGroupName

public java.lang.String getFormattingGroupName()

Description copied from class: AbstractBaseResourceHandler

Returns the formatting group name for resolving the struts action of the formatting JSP. Overwrite this method in your resource handler class to return a formatting group name specific to your resource handler.

Specified by:

getFormattingGroupName in interface IResourceHandler

Overrides:

getFormattingGroupName in class AbstractBaseResourceHandler

Returns:

the formatting group name.

See Also:

AbstractBaseResourceHandler.getFormattingGroupName()

getHelper

public CouponHelper getHelper()

This method returns the BOD helper associated with the Coupon resource. This method can be override to use the extended CouponHelper for customization.

Returns:

CouponHelper

getCoupon

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

This method returns the coupon list for the current shopper.

Parameters:

storeId - the store id

responseFormat - the response format

pageNumber - the page number.

pageSize - the page size.

Returns:

a collection of coupons in the specified format.

deleteCouponById

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

This method deletes the coupon by coupon id.

Parameters:

storeId - the store id.

couponId - the coupon id.

responseFormat - the response format.

Returns:

the response

preProcess

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

This method can be used to do the pre-processing of the response map before the entity provider is invoked passing the response map.

Specified by:

preProcess in interface IResourceHandler

Overrides:

preProcess in class AbstractBaseResourceHandler

Parameters:

responseMap - the response map.

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. In this method, it replaces the noun name WalletItem with Coupon.

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.

issueCoupon

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

This method is used by shopper to self-obtain a coupon.

Parameters:

storeId - the store id.

responseFormat - the response format.

Returns:

the response.