atg.commerce.order.restresources

Class CommerceItemRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractCommerceIdentifierRestSubresource

atg.commerce.order.restresources.CommerceItemRestSubresource

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

Direct Known Subclasses:

CartCommerceItemRestSubresource

@RestResource(id="atg.commerce.order.restresources.CommerceItemRestSubresource")
public class CommerceItemRestSubresource
extends AbstractCommerceIdentifierRestSubresource

This class provides the GET operations for the commerce items sub resource.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COMMERCE_ITEM_ID_PATH_PARAM
static java.lang.String	ERR_COMMERCE_ITEM_NOT_AVAILABLE_IN_ORDER
protected java.lang.String	mEmbeddedProductRelationshipName
protected java.lang.String	mEmbeddedSkuRelationshipName
protected atg.commerce.promotion.GWPMarkerManager	mGwpMarkerManager
protected java.lang.String	mItemGWPDiscountInfoRelationshipName
protected java.lang.String	mUnitPricesRelationshipName
static java.lang.String	REQUESTED_BEANS_QUERY_PARAM
static java.lang.String	UNITS
static java.lang.String	VIEW_QUERY_PARAM

Fields inherited from class atg.commerce.order.restresources.AbstractCommerceIdentifierRestSubresource

DEFAULT_PAGE_SIZE, mEmbeddedCommerceItemRelationshipName, mEmbeddedPaymentGroupRelationshipName, mEmbeddedShippingGroupRelationshipName, RESOURCE_NAME, sResourceBundle

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

Method Summary

Modifier and Type	Method and Description
RepresentationModel	getCommerceItem(java.lang.String pCommerceItemId, java.lang.String pView, java.lang.String pRequestedBeans) Returns a representation of a commerce item from a given parent order.
protected CommerceItem	getCommerceItemFromOrder(Order pOrder, java.lang.String pCommerceItemId) Return the given CommerceItem from the Order.
java.lang.String	getEmbeddedProductRelationshipName() Get the relationship name used for the embedded product resource.
java.lang.String	getEmbeddedSkuRelationshipName() Get the relationship name used for the embedded sku resource.
protected RepositoryItem[]	getGiftWithPurchaseDetails(CommerceItem pCommerceItem) This method returns the gift with purchase information associated with a commerce item.
atg.commerce.promotion.GWPMarkerManager	getGwpMarkerManager() Getter for the GWP marker manager
java.lang.String	getItemGWPDiscountInfoRelationshipName() Return the relationship name of the item gwp discount info, defaults to 'giftWithPurchaseDiscountInfo'
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
java.lang.String	getUnitPriceBeanOverrideFilterId() Returns the UnitPriceBeanOverrideFilterId property, used when view=units is selected.
protected java.util.List<atg.commerce.pricing.UnitPriceBean>	getUnitPriceBeans(Order pOrder, CommerceItem pCommerceItem, java.lang.String pRequestedBeans) Retrieves a list of UnitPriceBeans from the Order or CommerceItem.
java.lang.String	getUnitPriceBeanStateMapKey()
java.lang.String	getUnitPricesRelationshipName() Get the unit prices relationship name.
protected boolean	isRequestedBeanToBeHandled(java.lang.String pRequestedBean) Validation checks to ensure that requestBean has been set.
RepresentationModel	listCommerceItems(java.lang.String pView, java.lang.String pRequestedBeans, java.lang.String pOffset, java.lang.String pLimit, java.lang.String pGetForUpdate) For the given Order there are two possible return values driven by the value of the 'view' query parameter.
void	setEmbeddedProductRelationshipName(java.lang.String pEmbeddedProductRelationshipName) Configure the relationship name used for the embedded product resource.
void	setEmbeddedSkuRelationshipName(java.lang.String pEmbeddedSkuRelationshipName) Configure the relationship name used for the embedded sku resource.
void	setGwpMarkerManager(atg.commerce.promotion.GWPMarkerManager pGwpMarkerManager) Setter for the GWP marker manager
void	setItemGWPDiscountInfoRelationshipName(java.lang.String pItemGWPDiscountInfoRelationshipName) Configure the relationship name used for the item gift with purchase discount information The configured name is used by the filter schema to display the property in the payload.
void	setUnitPriceBeanOverrideFilterId(java.lang.String pUnitPriceBeanOverrideFilterId) Sets the UnitPriceBeanOverrideFilterId property, used for when view=units is selected.
void	setUnitPriceBeanStateMapKey(java.lang.String mUnitPriceBeanStateMapKey)
void	setUnitPricesRelationshipName(java.lang.String pUnitPricesRelationshipName) Set the unit prices relationship name

Methods inherited from class atg.commerce.order.restresources.AbstractCommerceIdentifierRestSubresource

addCreatedItemUri, buildMemberUris, getCartUri, getCreatedItemUri, getDefaultLimit, getEmbeddedCartRelationshipName, getEmbeddedCommerceItemRelationshipName, getEmbeddedPaymentGroupRelationshipName, getEmbeddedShippingGroupRelationshipName, getOrder, getRelationshipCreated, getRelationships, getRepresentationModelBuilder, getRepresentationModelBuilderWithCart, getRepresentationModelBuilderWithCart, getRepresentationModelBuilderWithPaging, getSelfLink, setDefaultLimit, setEmbeddedCartRelationshipName, setEmbeddedCommerceItemRelationshipName, setEmbeddedPaymentGroupRelationshipName, setEmbeddedShippingGroupRelationshipName

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

UNITS

public static final java.lang.String UNITS

See Also:

Constant Field Values

COMMERCE_ITEM_ID_PATH_PARAM

public static final java.lang.String COMMERCE_ITEM_ID_PATH_PARAM

See Also:

Constant Field Values

VIEW_QUERY_PARAM

public static final java.lang.String VIEW_QUERY_PARAM

See Also:

Constant Field Values

REQUESTED_BEANS_QUERY_PARAM

public static final java.lang.String REQUESTED_BEANS_QUERY_PARAM

See Also:

Constant Field Values

ERR_COMMERCE_ITEM_NOT_AVAILABLE_IN_ORDER

public static final java.lang.String ERR_COMMERCE_ITEM_NOT_AVAILABLE_IN_ORDER

See Also:

Constant Field Values

mGwpMarkerManager

protected atg.commerce.promotion.GWPMarkerManager mGwpMarkerManager

mItemGWPDiscountInfoRelationshipName

protected java.lang.String mItemGWPDiscountInfoRelationshipName

mEmbeddedProductRelationshipName

protected java.lang.String mEmbeddedProductRelationshipName

mEmbeddedSkuRelationshipName

protected java.lang.String mEmbeddedSkuRelationshipName

mUnitPricesRelationshipName

protected java.lang.String mUnitPricesRelationshipName

Constructor Detail

CommerceItemRestSubresource

public CommerceItemRestSubresource()

Method Detail

getUnitPriceBeanStateMapKey

public java.lang.String getUnitPriceBeanStateMapKey()

setUnitPriceBeanStateMapKey

public void setUnitPriceBeanStateMapKey(java.lang.String mUnitPriceBeanStateMapKey)

setUnitPriceBeanOverrideFilterId

public void setUnitPriceBeanOverrideFilterId(java.lang.String pUnitPriceBeanOverrideFilterId)

Sets the UnitPriceBeanOverrideFilterId property, used for when view=units is selected.

Parameters:

pUnitPriceBeanOverrideFilterId - set the UnitPriceBeanOverrideFilterId property to this value

getUnitPriceBeanOverrideFilterId

public java.lang.String getUnitPriceBeanOverrideFilterId()

Returns the UnitPriceBeanOverrideFilterId property, used when view=units is selected.

Default filter id is unitPriceBean-Default.

Returns:

The UnitPriceBeanOverrideFilterId property

getGwpMarkerManager

public atg.commerce.promotion.GWPMarkerManager getGwpMarkerManager()

Getter for the GWP marker manager

Returns:

GWPMarkerManager

setGwpMarkerManager

public void setGwpMarkerManager(atg.commerce.promotion.GWPMarkerManager pGwpMarkerManager)

Setter for the GWP marker manager

Parameters:

pGwpMarkerManager - GWPMarkerManager

setItemGWPDiscountInfoRelationshipName

public void setItemGWPDiscountInfoRelationshipName(java.lang.String pItemGWPDiscountInfoRelationshipName)

Configure the relationship name used for the item gift with purchase discount information The configured name is used by the filter schema to display the property in the payload.

Parameters:

pItemGWPDiscountInfoRelationshipName - the name of the item gwp discount info relationship name

getItemGWPDiscountInfoRelationshipName

public java.lang.String getItemGWPDiscountInfoRelationshipName()

Return the relationship name of the item gwp discount info, defaults to 'giftWithPurchaseDiscountInfo'

Returns:

the relationship name of the item gift with purchase discount info

setEmbeddedProductRelationshipName

public void setEmbeddedProductRelationshipName(java.lang.String pEmbeddedProductRelationshipName)

Configure the relationship name used for the embedded product resource.

Parameters:

pEmbeddedProductRelationshipName - the name of the relationship to the embedded product resource.

getEmbeddedProductRelationshipName

public java.lang.String getEmbeddedProductRelationshipName()

Get the relationship name used for the embedded product resource.

Returns:

the relationship name for the embedded product resource.

setEmbeddedSkuRelationshipName

public void setEmbeddedSkuRelationshipName(java.lang.String pEmbeddedSkuRelationshipName)

Configure the relationship name used for the embedded sku resource.

Parameters:

pEmbeddedSkuRelationshipName - the name of the relationship to the embedded sku resource.

getEmbeddedSkuRelationshipName

public java.lang.String getEmbeddedSkuRelationshipName()

Get the relationship name used for the embedded sku resource.

Returns:

the relationship name for the embedded sku resource.

setUnitPricesRelationshipName

public void setUnitPricesRelationshipName(java.lang.String pUnitPricesRelationshipName)

Set the unit prices relationship name

Parameters:

pUnitPricesRelationshipName - the unit prices relationship name

getUnitPricesRelationshipName

public java.lang.String getUnitPricesRelationshipName()

Get the unit prices relationship name.

Returns:

the unit prices relationship name.

getCommerceItem

@Endpoint(id="/{commerceItemId}#GET",
          isSingular=true,
          linkRelation="getCommerceItem",
          filterId="commerceItems.id-Default")
public RepresentationModel getCommerceItem(java.lang.String pCommerceItemId,
                                                                                                                                                                                                     java.lang.String pView,
                                                                                                                                                                                                     java.lang.String pRequestedBeans)
                                                                                                                                                                                              throws RestException,
                                                                                                                                                                                                     CommerceException

Returns a representation of a commerce item from a given parent order. Notes

• There are embedded URI calls to skus and products.
• When the 'view' query param is passed with a 'units' value, the commerce item's unit prices will be returned also. See #getUnitPriceBeanOverrideFilterId()) for configurable filter used in this case.

Parameters:

pCommerceItemId - - the commerce item to look up in the order

Returns:

RepresentationModel representing the commerce item

Throws:

RestException - if a problem occurs retrieving the commerce item

CommerceException - if a problem occurs retrieving the commerce item

listCommerceItems

@Endpoint(id="/{commerceItems}#GET",
          isSingular=false,
          linkRelation="getCommerceItems",
          filterId="commerceItems-Default")
public RepresentationModel listCommerceItems(java.lang.String pView,
                                                                                                                                                                                                     java.lang.String pRequestedBeans,
                                                                                                                                                                                                     java.lang.String pOffset,
                                                                                                                                                                                                     java.lang.String pLimit,
                                                                                                                                                                                                     java.lang.String pGetForUpdate)
                                                                                                                                                                                              throws RestException

For the given Order there are two possible return values driven by the value of the 'view' query parameter. If the value is 'units' then a list of UnitPriceBeans is returned @see atg.commerce.pricing.UnitPriceBean. If 'units' is not set then a list of CommerceItems are returned @see atg.commerce.order.CommerceItem. If UnitPriceBeans are returned an additional query parameter can be applied called RequestBeans, see below for details.

Parameters:

pView - the representation view to be returned.

pRequestedBeans - the kind of beans we wish to retrieve. Supported : groupOnly - only generate beans for the quantities of commerce items included in discount groups. allByGroup - generate price beans for all commerce items whether grouped or not, but ordering will take account of grouping where relevant.

pOffset - the page start index

pLimit - the page size

pGetForUpdate - flag indicating that the GET response will be used for a subsequent PATCH merge. Used so framework knows to output item ids before and after the paged collection so that unpaged items will not be deleted from the collection on the subsequent PATCH merge

Returns:

RepresentationModel representing the list of CommerceItems or UnitPriceBeans.

Throws:

RestException - if a problem occurred whilst obtaining the commerce item information

getRepresentationModelBuilder

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

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

The product and sku are also embedded and gift with purchase information is included as additional state.

Overrides:

getRepresentationModelBuilder in class AbstractCommerceIdentifierRestSubresource

Parameters:

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

Returns:

RepresentationModel.Builder containing the state

Throws:

RestException

getGiftWithPurchaseDetails

protected RepositoryItem[] getGiftWithPurchaseDetails(CommerceItem pCommerceItem)

This method returns the gift with purchase information associated with a commerce item.

Parameters:

pCommerceItem - The item to inspect for gwp information.

Returns:

RepositoryItem[] array of gwpCommerceItemMarker repository items.

getUnitPriceBeans

protected java.util.List<atg.commerce.pricing.UnitPriceBean> getUnitPriceBeans(Order pOrder,
                                                                               CommerceItem pCommerceItem,
                                                                               java.lang.String pRequestedBeans)
                                                                        throws PricingException

Retrieves a list of UnitPriceBeans from the Order or CommerceItem.

Parameters:

pOrder - - the Order on which to look up the UnitPriceBeans.

pCommerceItem - - the CommerceItem on which to look up the UnitPriceBeans.

pRequestedBeans - - the kind of beans we wish to retrieve. Supported : groupOnly - only generate beans for the quantities of commerce items included in discount groups. allByGroup - generate price beans for all commerce items whether grouped or not, but ordering will take account of grouping where relevant.

Returns:

List of UnitPriceBeans.

Throws:

RestException - if a problem as occurred retrieving the UnitPriceBeans.

PricingException

getCommerceItemFromOrder

protected CommerceItem getCommerceItemFromOrder(Order pOrder,
                                                java.lang.String pCommerceItemId)
                                         throws RestException

Return the given CommerceItem from the Order.

Parameters:

pOrder - - the Order on which to lookup the CommerceItem.

pCommerceItemId - - the commerce id of interest.

Returns:

the CommerceItem.

Throws:

RestException - if there is a problem retrieving the CommerceItem from the Order (404 NOT FOUND).

isRequestedBeanToBeHandled

protected boolean isRequestedBeanToBeHandled(java.lang.String pRequestedBean)

Validation checks to ensure that requestBean has been set.

Parameters:

pRequestedBean - - the groupby details to be applied to the generation of UnitPriceBeans.

Returns:

true to indicate that requestBean has been set.