atg.commerce.promotion.restresources

Class ClosenessQualifierRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.promotion.restresources.ClosenessQualifierRestSubresource

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.ClosenessQualifierRestSubresource")
public class ClosenessQualifierRestSubresource
extends GenericService

This class provides the end points for the closeness qualifier sub resource.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mEmbeddedPromotionRelationshipName
protected java.lang.String	mEmbeddedUpsellProductsRelationshipName
static java.lang.String	PARENT_ITEM_ID
static java.lang.String	PARENT_ITEM_TYPE
static java.lang.String	PARENT_PROPERTY_NAME
static java.lang.String	PROMOTION
static java.lang.String	RESOURCE_NAME
static java.util.ResourceBundle	sResourceBundle Resource bundle
static java.lang.String	UPSELL_ACTION
static java.lang.String	UPSELL_PRODUCTS

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

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.
RepresentationModel	getClosenessQualifier(java.lang.String pClosenessQualifierId) Gets the representation model object of closeness qualifier item from the repository for the given closeness qualifier id.
java.lang.String	getClosenessQualifierDroplet() Gets the ClosenessQualifierDroplet component path.
java.lang.String	getClosenessQualifierItemDescriptorName() Get the closeness qualifier item descriptor name.
protected java.util.List<RepositoryItem>	getClosenessQualifierItems(Order pOrder, java.lang.String pType) Get closeness qualifier repository items associated to a given order and for a given type.
RepresentationModel	getClosenessQualifiers(java.lang.String pType) Returns the collection of closeness qualifiers applied to the current cart.
java.lang.String	getEmbeddedPromotionRelationshipName() Get the relationship name used for the embedded promotion resource.
java.lang.String	getEmbeddedUpsellProductsRelationshipName() Get the relationship name used for the embedded upsell products resource.
Order	getOrder() Retrieve the order from the request cache.
OrderManager	getOrderManager() Returns the OrderManager component path.
PricingModelProperties	getPricingModelProperties() Gets the Pricing Model Properties component that stores all the properties of the pricing model
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.
void	setClosenessQualifierDroplet(java.lang.String pClosenessQualifierDroplet) Sets the ClosenessQualifierDroplet component path.
void	setClosenessQualifierItemDescriptorName(java.lang.String pClosenessQualifierItemDescriptorName) Set the closeness qualifier item descriptor name.
void	setEmbeddedPromotionRelationshipName(java.lang.String pEmbeddedPromotionRelationshipName) Configure the relationship name used for the embedded promotion resource.
void	setEmbeddedUpsellProductsRelationshipName(java.lang.String pEmbeddedUpsellProductsRelationshipName) Configure the relationship name used for the embedded upsell products resource.
void	setOrderManager(OrderManager pOrderManager) Sets the OrderManager component path.
void	setPricingModelProperties(PricingModelProperties pPricingModelProperties) Sets the Pricing Model Properties component that stores all the properties of the pricing model
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, clearAbsoluteNameAndContext, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, isStartServiceComplete, 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

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

PARENT_ITEM_ID

public static final java.lang.String PARENT_ITEM_ID

See Also:

Constant Field Values

PARENT_ITEM_TYPE

public static final java.lang.String PARENT_ITEM_TYPE

See Also:

Constant Field Values

PARENT_PROPERTY_NAME

public static final java.lang.String PARENT_PROPERTY_NAME

See Also:

Constant Field Values

UPSELL_ACTION

public static final java.lang.String UPSELL_ACTION

See Also:

Constant Field Values

PROMOTION

public static final java.lang.String PROMOTION

See Also:

Constant Field Values

UPSELL_PRODUCTS

public static final java.lang.String UPSELL_PRODUCTS

See Also:

Constant Field Values

sResourceBundle

public static java.util.ResourceBundle sResourceBundle

Resource bundle

mEmbeddedUpsellProductsRelationshipName

protected java.lang.String mEmbeddedUpsellProductsRelationshipName

mEmbeddedPromotionRelationshipName

protected java.lang.String mEmbeddedPromotionRelationshipName

Constructor Detail

ClosenessQualifierRestSubresource

public ClosenessQualifierRestSubresource()

Method Detail

setPricingModelProperties

public void setPricingModelProperties(PricingModelProperties pPricingModelProperties)

Sets the Pricing Model Properties component that stores all the properties of the pricing model

Parameters:

pPricingModelProperties - the Pricing Model Properties component that stores all the properties of the pricing model

getPricingModelProperties

public PricingModelProperties getPricingModelProperties()

Gets the Pricing Model Properties component that stores all the properties of the pricing model

Returns:

the Pricing Model Properties component that stores all the properties of the pricing model

getOrderManager

public OrderManager getOrderManager()

Returns the OrderManager component path.

Returns:

the OrderManager component path.

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

Sets the OrderManager component path.

Parameters:

pOrderManager - the OrderManager component path to set.

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

getClosenessQualifierItemDescriptorName

public java.lang.String getClosenessQualifierItemDescriptorName()

Get the closeness qualifier item descriptor name.

setClosenessQualifierItemDescriptorName

public void setClosenessQualifierItemDescriptorName(java.lang.String pClosenessQualifierItemDescriptorName)

Set the closeness qualifier item descriptor name.

getClosenessQualifierDroplet

public java.lang.String getClosenessQualifierDroplet()

Gets the ClosenessQualifierDroplet component path.

Returns:

A nucleus path to the ClosenessQualifierDroplet component.

setClosenessQualifierDroplet

public void setClosenessQualifierDroplet(java.lang.String pClosenessQualifierDroplet)

Sets the ClosenessQualifierDroplet component path.

Parameters:

pClosenessQualifierDroplet - a nucleus path to ClosenessQualifierDroplet component.

setEmbeddedUpsellProductsRelationshipName

public void setEmbeddedUpsellProductsRelationshipName(java.lang.String pEmbeddedUpsellProductsRelationshipName)

Configure the relationship name used for the embedded upsell products resource.

Parameters:

pEmbeddedUpsellProductsRelationshipName - the name of the relationship to the embedded upsell products resource.

getEmbeddedUpsellProductsRelationshipName

public java.lang.String getEmbeddedUpsellProductsRelationshipName()

Get the relationship name used for the embedded upsell products resource.

Returns:

the relationship name for the embedded upsell products resource.

setEmbeddedPromotionRelationshipName

public void setEmbeddedPromotionRelationshipName(java.lang.String pEmbeddedPromotionRelationshipName)

Configure the relationship name used for the embedded promotion resource.

Parameters:

pEmbeddedPromotionRelationshipName - the name of the relationship to the embedded promotion resource.

getEmbeddedPromotionRelationshipName

public java.lang.String getEmbeddedPromotionRelationshipName()

Get the relationship name used for the embedded promotion resource.

Returns:

the relationship name for the embedded promotion resource.

getClosenessQualifier

@Endpoint(id="/closenessQualifiers/{closenessQualifierId}#GET",
          isSingular=true,
          filterId="closenessQualifiers.id-Default")
public RepresentationModel getClosenessQualifier(java.lang.String pClosenessQualifierId)
                                                                                                                                                                                          throws RestException,
                                                                                                                                                                                                 RepositoryException

Gets the representation model object of closeness qualifier item from the repository for the given closeness qualifier id.

Parameters:

pClosenessQualifierId - The closeness qualifier repository item id that needs to fetched from the repository.

Returns:

The representation model object having the closeness qualifier repository item.

Throws:

RestException - If there is a problem while fetching the closeness qualifier from the repository.

RepositoryException - if the closeness qualifier item could not be retrieved.

getClosenessQualifiers

@Endpoint(id="/closenessQualifiers#GET",
          isSingular=false,
          filterId="closenessQualifiers-Default")
public RepresentationModel getClosenessQualifiers(java.lang.String pType)
                                                                                                                                                                  throws RestException,
                                                                                                                                                                         CommerceException

Returns the collection of closeness qualifiers applied to the current cart.

Parameters:

pType - The type of closenessQualifiers to be returned. It can be item, order, shipping or all. If pType is null, all the closenessQualifiers associated to the current cart will be returned.

Returns:

the representation model corresponding to the closeness qualifiers.

Throws:

RestException - if an internal server error occurs

CommerceException - if failed to load order

getClosenessQualifierItems

protected java.util.List<RepositoryItem> getClosenessQualifierItems(Order pOrder,
                                                                    java.lang.String pType)

Get closeness qualifier repository items associated to a given order and for a given type. If no type information is provided, all the closeness qualifiers associated to the current shopping cart will be returned.

Parameters:

pOrder - the order for which the closeness qualifier repository items need to be retrieved.

pType - the type of the closeness qualifier.

Returns:

the list of closeness qualifier repository items associated to a given order.

getRepresentationModelBuilder

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

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

Also embeds promotion and upsellProducts summaries.

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

getOrder

public Order getOrder()
               throws RestException

Retrieve the order from the request cache.

Returns:

the order from the request cache.

Throws:

RestException - if there is a problem obtaining the order.