atg.commerce.promotion.restresources

Class PromotionRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.promotion.restresources.PromotionRestResource

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

@RestResource(id="atg.commerce.promotion.restresources.PromotionRestResource")
public class PromotionRestResource
extends GenericService

This class provides the end points for the promotion resource.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	ELEMENT_PARAM
static java.lang.String	ERR_NO_MATCHING_ORDER_FOUND
static java.lang.String	ERR_REQUIRED_INPUT_MISSING
static java.lang.String	ERROR_PARAM
static java.lang.String	OUTPUT_PARAM
static java.lang.String	OUTPUT_PARAM_PROMOTIONS
static java.lang.String	PRODUCT_ID_PARAM
static java.lang.String	QUANTITY_PARAM
static java.lang.String	RESOURCE_NAME
static java.lang.String	SKU_ID_PARAM
static java.util.ResourceBundle	sResourceBundle Resource bundle

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
PromotionRestResource()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String[]	buildMemberUris(java.util.Collection<RepositoryItem> pMembers, <any> pQueryParams) Build the members URIs for the given list of items of type RepositoryItem.
protected RepresentationModel.Builder	getApplicableItemPromotions(java.lang.String pProductId, java.lang.String pSkuId, java.lang.String pQuantity) Returns a representation model containing a collection of applicable item promotions for the given product/sku/quantity combination.
java.lang.String	getGetApplicablePromotionsPath() Gets the GetApplicablePromotions component path.
RepresentationModel	getPromotion(java.lang.String pPromotionId) Gets the representation model object of the promotion for the given promotion Id.
protected RepresentationModel.Builder	getPromotions(java.lang.String pOrderId) Returns a representation model containing a collection of promotions applied to a given order for the current user.
RepresentationModel	getPromotions(java.lang.String pOrderId, java.lang.String pProductId, java.lang.String pSkuId, java.lang.String pQuantity) Returns the collection of promotions applied to a given order for the current user.
PromotionTools	getPromotionTools() Gets the promotion tools component that provides utility methods for the promotion retrieval
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.util.Collection<RepositoryItem> pMembers) Gets the RepresentationModel.Builder with the given collection of RepositoryItems being used to build member URIs.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
protected RepositoryItem	retrievePromotion(java.lang.String pPromotionId) Retrieve the promotion for the given promotion Id.
void	setGetApplicablePromotionsPath(java.lang.String pGetApplicablePromotionsPath) Sets the GetApplicablePromotions component path.
void	setPromotionTools(PromotionTools pPromotionTools) Sets the the promotion tools component that provides utility methods for the promotion retrieval

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

ERR_REQUIRED_INPUT_MISSING

public static final java.lang.String ERR_REQUIRED_INPUT_MISSING

See Also:

Constant Field Values

ERR_NO_MATCHING_ORDER_FOUND

public static final java.lang.String ERR_NO_MATCHING_ORDER_FOUND

See Also:

Constant Field Values

ELEMENT_PARAM

public static final java.lang.String ELEMENT_PARAM

See Also:

Constant Field Values

OUTPUT_PARAM

public static final java.lang.String OUTPUT_PARAM

See Also:

Constant Field Values

ERROR_PARAM

public static final java.lang.String ERROR_PARAM

See Also:

Constant Field Values

OUTPUT_PARAM_PROMOTIONS

public static final java.lang.String OUTPUT_PARAM_PROMOTIONS

See Also:

Constant Field Values

PRODUCT_ID_PARAM

public static final java.lang.String PRODUCT_ID_PARAM

See Also:

Constant Field Values

SKU_ID_PARAM

public static final java.lang.String SKU_ID_PARAM

See Also:

Constant Field Values

QUANTITY_PARAM

public static final java.lang.String QUANTITY_PARAM

See Also:

Constant Field Values

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

sResourceBundle

public static java.util.ResourceBundle sResourceBundle

Resource bundle

Constructor Detail

PromotionRestResource

public PromotionRestResource()

Method Detail

setPromotionTools

public void setPromotionTools(PromotionTools pPromotionTools)

Sets the the promotion tools component that provides utility methods for the promotion retrieval

Parameters:

pPromotionTools - the promotion tools component that provides utility methods for the promotion retrieval

getPromotionTools

public PromotionTools getPromotionTools()

Gets the promotion tools component that provides utility methods for the promotion retrieval

Returns:

the promotion tools component that provides utility methods for the promotion retrieval

getGetApplicablePromotionsPath

public java.lang.String getGetApplicablePromotionsPath()

Gets the GetApplicablePromotions component path.

Returns:

Nucleus path to the GetApplicablePromotions component.

setGetApplicablePromotionsPath

public void setGetApplicablePromotionsPath(java.lang.String pGetApplicablePromotionsPath)

Sets the GetApplicablePromotions component path.

Parameters:

pGetApplicablePromotionsPath - Nucleus path to GetApplicablePromotions component.

getPromotion

@Endpoint(id="/promotions/{promotionId}#GET",
          isSingular=true,
          filterId="promotions.id-Default")
public RepresentationModel getPromotion(java.lang.String pPromotionId)
                                                                                                                                                      throws RestException,
                                                                                                                                                             RepositoryException

Gets the representation model object of the promotion for the given promotion Id.

Parameters:

pPromotionId - the id of the promotion to be retrieved

Returns:

The representation model object of the promotion

Throws:

RestException - If an error occurs retrieving the promotion

RepositoryException - If an error occurs retrieving the promotion

getPromotions

@Endpoint(id="/promotions/#GET",
          isSingular=false,
          filterId="promotions-Summary")
public RepresentationModel getPromotions(java.lang.String pOrderId,
                                                                                                                                               java.lang.String pProductId,
                                                                                                                                               java.lang.String pSkuId,
                                                                                                                                               java.lang.String pQuantity)
                                                                                                                                        throws RestException,
                                                                                                                                               CommerceException

Returns the collection of promotions applied to a given order for the current user.

If the request contains productId and(or) skuId, and an optional quantity value, then a collection of applicable item promotions for the given product/sku/quantity combination are returned.

Parameters:

pOrderId - The id of the order for which the applied promotions has to be returned.

pProductId - The id of the product.

pSkuId - The sku id.

pQuantity - The quantity value.

Returns:

the representation model corresponding to the promotions.

Throws:

RestException - if an error occurs retrieving the promotions

CommerceException - if an error occurs retrieving the promotions

getPromotions

protected RepresentationModel.Builder getPromotions(java.lang.String pOrderId)
                                             throws CommerceException

Returns a representation model containing a collection of promotions applied to a given order for the current user.

Parameters:

pOrderId - The id of the order for which the applied promotions has to be returned.

Returns:

a representation model containing a collection of promotions applied to a given order for the current user.

Throws:

CommerceException - if fails to load order.

getApplicableItemPromotions

protected RepresentationModel.Builder getApplicableItemPromotions(java.lang.String pProductId,
                                                                  java.lang.String pSkuId,
                                                                  java.lang.String pQuantity)

Returns a representation model containing a collection of applicable item promotions for the given product/sku/quantity combination.

Parameters:

pProductId - The product id.

pSkuId - The sku id.

pQuantity - The quantity value.

Returns:

a representation model containing a collection of applicable item promotions for the given product/sku/quantity combination.

retrievePromotion

protected RepositoryItem retrievePromotion(java.lang.String pPromotionId)
                                    throws RestException,
                                           RepositoryException

Retrieve the promotion for the given promotion Id.

Parameters:

pPromotionId - the id of the promotion for which we want to retrieve

Returns:

the required promotion

Throws:

RestException - if there is a problem retrieving the promotion

RepositoryException - if there is a problem retrieving the promotion

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.Object pState)

Gets the RepresentationModel.Builder with the given object acting as the state.

Parameters:

pState - the state that will be added to the representation model

Returns:

RepresentationModel.Builder containing the state

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.util.Collection<RepositoryItem> pMembers)
                                                             throws RestException

Gets the RepresentationModel.Builder with the given collection of RepositoryItems being used to build member URIs.

Parameters:

pMembers - the members that will be added to the representation model

Returns:

RepresentationModel.Builder containing the member uris

Throws:

RestException - if the member URIs could not be built

buildMemberUris

protected java.lang.String[] buildMemberUris(java.util.Collection<RepositoryItem> pMembers,
                                             <any> pQueryParams)
                                      throws RestException

Build the members URIs for the given list of items of type RepositoryItem.

Parameters:

pMembers - the list of repository items from which to build the member URIs

pQueryParams - optional map of query param key/value pairs to be added to any built uris, null if none

Returns:

an array of URI's where each element represents a GET URI

Throws:

RestException - if a problem occurred whilst building the member URIs