com.ibm.commerce.rest.order.handler

Class AssignedCouponHandler

java.lang.Object

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

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

com.ibm.commerce.rest.order.handler.AssignedCouponHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/cart/@self/assigned_coupon")
 @Encoded
public class AssignedCouponHandler
extends AbstractResourceHandler

This class provides RESTful services to add, get, update, and delete assigned coupons for the current shopping cart.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
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
AssignedCouponHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	applyCoupon(java.lang.String storeId, java.lang.String responseFormat) This method apply coupon to the shopping cart.
javax.ws.rs.core.Response	getAssignedCouponInfo(java.lang.String storeId, java.lang.String responseFormat) Get assigned coupon info for the shopping cart.
java.lang.String	getCalculationUsageIds() This method returns the calculation usage ids.
java.lang.String	getExternalResourceName() Get the resource name to show externally.
OrderHelper	getHelper() This method returns the Order helper.
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	removeCoupon(java.lang.String storeId, java.lang.String couponId, java.lang.String responseFormat) Remove a coupon from the shopping cart.
void	setCalculationUsageIds(java.lang.String ids) This method sets the value for calculation usage ids.

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, getFormattedMessage, getFormattedMessageWithLocale, getFormattingGroupName, getInstrumentor, getIntegerParameterValue, getIntegerParameterValues, getLongParameterValue, getLongParameterValues, getParameterValue, getParameterValue, getParameterValues, getQueryRegistry, getRequest, getResponse, getUriInfo, handleException, initializeActionRegistry, initializeQueryRegistry, performAction, postProcess, 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

Constructor Detail

AssignedCouponHandler

public AssignedCouponHandler()

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

getCalculationUsageIds

public java.lang.String getCalculationUsageIds()

This method returns the calculation usage ids.

Returns:

calulation usage ids.

setCalculationUsageIds

public void setCalculationUsageIds(java.lang.String ids)

This method sets the value for calculation usage ids.

Parameters:

ids - identifiers.

getHelper

public OrderHelper getHelper()

This method returns the Order helper.

Returns:

OrderHelper

getAssignedCouponInfo

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

Get assigned coupon info for the shopping cart.

Parameters:

storeId - the store id

responseFormat - the response format

Returns:

the assigned coupon info

applyCoupon

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

This method apply coupon to the shopping cart.

Parameters:

storeId - the store id.

responseFormat - the response format (xml, json, or atom).

Returns:

A map of String [] that contains the following response parameters: orderId, couponId.

removeCoupon

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

Remove a coupon from the shopping cart.

Parameters:

storeId - the store id.

couponId - the coupon id.

responseFormat - the response format.

Returns:

the response.

getExternalResourceName

public java.lang.String getExternalResourceName()

Description copied from class: AbstractBaseResourceHandler

Get the resource name to show externally. This defaults to the value returned by getResourceName if this method isn't overridden.

Overrides:

getExternalResourceName in class AbstractBaseResourceHandler

Returns:

The external resource name.