atg.commerce.order.restresources

Class CartCommerceItemRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractCommerceIdentifierRestSubresource

atg.commerce.order.restresources.CommerceItemRestSubresource

atg.commerce.order.restresources.CartCommerceItemRestSubresource

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, UpdateableRestResource, java.util.EventListener

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

This class provides the endpoints for commerce item related resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
OrderManager	mOrderManager
static java.lang.String	PROP_QUANTITY
static java.lang.String	PROP_QUANTITY_WITH_FRACTION
static java.lang.String	SHIPPING_GROUP_ID
static java.lang.String	ZERO

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

COMMERCE_ITEM_ID_PATH_PARAM, ERR_COMMERCE_ITEM_NOT_AVAILABLE_IN_ORDER, mEmbeddedProductRelationshipName, mEmbeddedSkuRelationshipName, mGwpMarkerManager, mItemGWPDiscountInfoRelationshipName, mUnitPricesRelationshipName, REQUESTED_BEANS_QUERY_PARAM, UNITS, 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
CartCommerceItemRestSubresource()

Method Summary

Modifier and Type	Method and Description
protected void	addInputsForAddItem(FormHandlerExecutor pExecutor, Order pOrder, org.json.JSONObject pInputJson, atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo, AddCommerceItemInfo[] pItemsToAdd) This method provides a place from which to add form handler input during the add item operation.
protected void	addInputsForDeleteItem(FormHandlerExecutor pExecutor, Order pOrder, java.lang.String pCommerceItemId) This method provides a place from which to add form handler input during the delete item operation.
protected void	addInputsForUpdateItems(FormHandlerExecutor pExecutor, Order pOrder, atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo) This method provides a place from which to add form handler input during the update item operation.
RepresentationModel	addItem(org.json.JSONObject pInputJson) Add an item to the Shopping Cart.
protected AddCommerceItemInfo	buildAddCommerceItemInfo(atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo) Builds an AddCommerceItemInfo from the given ResourceUpdateInfo.
java.lang.Object	deleteItem(java.lang.String pCommerceItemId) Deletes a commerce item related to the Order.
java.lang.String	getAddItemsHandleMethod() Gets the name of the CartModifierFormHandler method that is called for handling the adding of items.
java.lang.String	getCartModifierFormHandlerPath() Returns the CartModifierFormHandlerPath.
protected java.net.URI	getCreatedItemUri(FormHandlerExecutor pExecutor) Build a URI to the newly added/created CommerceItem if present.
java.lang.String	getDeleteItemHandleMethod() Gets the name of the CartModifierFormHandler method that is called for handling the deletion of an item.
protected AddCommerceItemInfo[]	getItemsToAdd(java.util.List<atg.service.jaxrs.ResourceUpdateInfo> pAddUpdateInfos) Build a list of AddCommerceItemInfos obtained from the ResourceUpdateInfos.
OrderManager	getOrderManager() Returns the OrderManager.
protected java.util.Map<java.lang.String,java.lang.String>	getUpdateData(java.util.List<atg.service.jaxrs.ResourceUpdateInfo> pResourceUpdateInfos) Builds a map with details of the quantities of the commerce items for update.
protected java.util.Map<java.lang.String,java.lang.String>	getUpdateData(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo, java.util.List<CommerceItem> pCommerceItems) Builds a map with details of the quantity of commerce item for update.
java.lang.String	getUpdateItemsHandleMethod() Gets the name of the CartModifierFormHandler method that is called for handling the updating and adding of items.
protected void	populateDataForUpdate(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo, java.util.Map<java.lang.String,java.lang.String> pDataForUpdate) Populates the given map with details of the quantity of commerce item for update.
void	setAddItemsHandleMethod(java.lang.String pAddItemsHandleMethod) Sets the name of the CartModifierFormHandler method that is called for handling the adding of items.
void	setCartModifierFormHandlerPath(java.lang.String pCartModifierFormHandlerPath) Sets the CartModifierFormHandlerPath.
void	setDeleteItemHandleMethod(java.lang.String pDeleteItemHandleMethod) Sets the name of the CartModifierFormHandler method that is called for handling the deletion of an item.
void	setOrderManager(OrderManager pOrderManager) Sets the OrderManager.
void	setUpdateItemsHandleMethod(java.lang.String pUpdateItemsHandleMethod) Sets the name of the CartModifierFormHandler method that is called for handling the updating and adding of items.
java.net.URI	update(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo) Updates the CommerceItems in the Cart.
RepresentationModel	updateItem(java.lang.String pCommerceItemId, org.json.JSONObject pInputJson) Updates a commerce item within the current order.
RepresentationModel	updateItems(org.json.JSONObject pInputJson) Using the PATCH Merge protocol add/remove/update items in the Cart.

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

getCommerceItem, getCommerceItemFromOrder, getEmbeddedProductRelationshipName, getEmbeddedSkuRelationshipName, getGiftWithPurchaseDetails, getGwpMarkerManager, getItemGWPDiscountInfoRelationshipName, getRepresentationModelBuilder, getUnitPriceBeanOverrideFilterId, getUnitPriceBeans, getUnitPriceBeanStateMapKey, getUnitPricesRelationshipName, isRequestedBeanToBeHandled, listCommerceItems, setEmbeddedProductRelationshipName, setEmbeddedSkuRelationshipName, setGwpMarkerManager, setItemGWPDiscountInfoRelationshipName, setUnitPriceBeanOverrideFilterId, setUnitPriceBeanStateMapKey, setUnitPricesRelationshipName

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

Methods inherited from interface atg.service.jaxrs.restresources.UpdateableRestResource

updateEmbeddedResources

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

PROP_QUANTITY_WITH_FRACTION

public static final java.lang.String PROP_QUANTITY_WITH_FRACTION

See Also:

Constant Field Values

PROP_QUANTITY

public static final java.lang.String PROP_QUANTITY

See Also:

Constant Field Values

SHIPPING_GROUP_ID

public static final java.lang.String SHIPPING_GROUP_ID

See Also:

Constant Field Values

ZERO

public static final java.lang.String ZERO

See Also:

Constant Field Values

mOrderManager

public OrderManager mOrderManager

Constructor Detail

CartCommerceItemRestSubresource

public CartCommerceItemRestSubresource()

Method Detail

getCartModifierFormHandlerPath

public java.lang.String getCartModifierFormHandlerPath()

Returns the CartModifierFormHandlerPath.

Returns:

the CartModifierFormHandlerPath.

setCartModifierFormHandlerPath

public void setCartModifierFormHandlerPath(java.lang.String pCartModifierFormHandlerPath)

Sets the CartModifierFormHandlerPath.

Parameters:

pCartModifierFormHandlerPath - - the CartModifierFormHandlerPath to set.

getDeleteItemHandleMethod

public java.lang.String getDeleteItemHandleMethod()

Gets the name of the CartModifierFormHandler method that is called for handling the deletion of an item.

The default value is "removeItemFromOrder".

Returns:

the delete item handle method

setDeleteItemHandleMethod

public void setDeleteItemHandleMethod(java.lang.String pDeleteItemHandleMethod)

Sets the name of the CartModifierFormHandler method that is called for handling the deletion of an item.

Parameters:

pDeleteItemHandleMethod - the name of the delete item handle method

getAddItemsHandleMethod

public java.lang.String getAddItemsHandleMethod()

Gets the name of the CartModifierFormHandler method that is called for handling the adding of items.

The default value is "addMultipleItemsToOrder".

Returns:

the add items handle method

setAddItemsHandleMethod

public void setAddItemsHandleMethod(java.lang.String pAddItemsHandleMethod)

Sets the name of the CartModifierFormHandler method that is called for handling the adding of items.

Parameters:

pAddItemsHandleMethod - the name of the add items handle method

getUpdateItemsHandleMethod

public java.lang.String getUpdateItemsHandleMethod()

Gets the name of the CartModifierFormHandler method that is called for handling the updating and adding of items.

The default value is "setOrderByCommerceId".

Returns:

the update and add items handle method

setUpdateItemsHandleMethod

public void setUpdateItemsHandleMethod(java.lang.String pUpdateItemsHandleMethod)

Sets the name of the CartModifierFormHandler method that is called for handling the updating and adding of items.

Parameters:

pUpdateItemsHandleMethod - the name of the update and add items handle method

getOrderManager

public OrderManager getOrderManager()

Returns the OrderManager.

Returns:

the OrderManager.

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

Sets the OrderManager.

Parameters:

pOrderManager - - the OrderManager to set.

addItem

@Endpoint(id="/{commerceItems}/#POST",
          validatorId="commerceItems.id-Full",
          filterId="commerceItems.id-FullWithCart",
          updateTarget=true)
public RepresentationModel addItem(org.json.JSONObject pInputJson)
                                                                                                                                                                                                   throws RestException,
                                                                                                                                                                                                          CommerceException,
                                                                                                                                                                                                          javax.servlet.ServletException

Add an item to the Shopping Cart. The input will be in the form of JSON that represents an AddCommerceItemInfo e.g.

 
  {
      {"productId":"xprod2124", "catalogRefId":"xsku2124", "quantity":"232", "siteId":"homeSite", ...}
  }
 
 

Parameters:

pInputJson - representation of the item to be added

Returns:

A Representation of the newly created CommerceItems.

Throws:

RestException - if a problem occurred whilst adding an item to the shopping cart

CommerceException

javax.servlet.ServletException

deleteItem

@Endpoint(id="/{commerceItemId}#DELETE",
          isSingular=true,
          filterId="commerceItems-Delete")
public java.lang.Object deleteItem(java.lang.String pCommerceItemId)
                                                                                                                                           throws RestException,
                                                                                                                                                  javax.servlet.ServletException

Deletes a commerce item related to the Order.

As the sub-resource delete can affect the top-level resource details, e.g. order level price info, we deviate from the normal NO_CONTENT response. We return @see atg.service.jaxrs.RepresentationModel with the top-level cart (summary) embedded in the response to reflect any changes. The response state will return the resource collection affected by the delete.

Parameters:

pCommerceItemId - - the commerce item to look up in the order and delete.

Returns:

a RepresentationModel response if the item was successfully deleted.

Throws:

RestException - if a problem occurred whilst deleting the commerce item

javax.servlet.ServletException

updateItem

@PATCH
 @Endpoint(id="/commerceItems/{id}#PATCH",
          isSingular=true,
          validatorId="commerceItems.id-Full",
          filterId="commerceItems.id-FullWithCart",
          updateTarget=true)
public RepresentationModel updateItem(java.lang.String pCommerceItemId,
                                                                                                                                                                                                                                                   org.json.JSONObject pInputJson)
                                                                                                                                                                                                                                            throws RestException,
                                                                                                                                                                                                                                                   CommerceException,
                                                                                                                                                                                                                                                   javax.servlet.ServletException

Updates a commerce item within the current order.

Parameters:

pCommerceItemId - id of the commerce item to update

pInputJson - representation of commerce item updates to apply

Returns:

the representation model containing the updated commerce item

Throws:

RestException - if an internal server error occurs while updating the commerce item

CommerceException - if a shipping group could not be set on the order

javax.servlet.ServletException - if a problem occurred whilst adding input to the form handler executor

updateItems

@PATCH
 @Endpoint(id="/{commerceItems}/#PATCH",
          validatorId="commerceItems-Full",
          filterId="commerceItems-DefaultWithCart",
          updateTarget=true)
public RepresentationModel updateItems(org.json.JSONObject pInputJson)
                                                                                                                                                                                                             throws RestException,
                                                                                                                                                                                                                    CommerceException,
                                                                                                                                                                                                                    javax.servlet.ServletException,
                                                                                                                                                                                                                    TransactionDemarcationException

Using the PATCH Merge protocol add/remove/update items in the Cart. The protocol states:

• If an item is not in collection then it is removed.
• If the item id is in the collection with no other properties then it is kept.
• If the item id is in the collection with other properties it is an update to the item.
• If the item as no id and other properties exist then the item is an add.

Example JSON:

   {
    "items":
      [
        {
          "id":"ci84000025"
        },
        {
          "id": "ci82000003",
          "quantity": 55.5
        },
        {
          "productId": "xprod2124",
          "catalogRefId": "xsku2124",
          "quantity": 123
        }
    ]
  }
 

Because the collection is a representation of CommerceItems this leads to an anomaly where the add operation will need to convert the properties received into an AddCommerceItemInfo.

Parameters:

pInputJson - representation of the items for update

Returns:

the representation model containing the updated commerce items

Throws:

RestException - if a problem occurred whilst updating the commerce items

CommerceException - if a shipping group could not be set on the order

javax.servlet.ServletException - if a problem occurred whilst adding input to the form handler executor

TransactionDemarcationException - if a problem occurred during transaction demarcation

update

public java.net.URI update(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo)
                    throws RestException

Updates the CommerceItems in the Cart.

Specified by:

update in interface UpdateableRestResource

Parameters:

pUpdateInfo - - update object containing request input and any existing repository (commerce items) data to be updated

Returns:

URI - self link to any newly created item, or null if none created

Throws:

RestException - - if an issue occurs performing the update

buildAddCommerceItemInfo

protected AddCommerceItemInfo buildAddCommerceItemInfo(atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo)

Builds an AddCommerceItemInfo from the given ResourceUpdateInfo. The ResourceUpdateInfo is assumed to be of type CommerceItem (as defined in the payload schema).

If you have a customized version of AddCommerceItemInfo and need to set additional data, override this method, make a call to super and set the appropriate properties.

Parameters:

pResourceUpdateInfo - a ResourceUpdateInfo that represents the item to be added

Returns:

a populated AddCommerceItemInfo

getItemsToAdd

protected AddCommerceItemInfo[] getItemsToAdd(java.util.List<atg.service.jaxrs.ResourceUpdateInfo> pAddUpdateInfos)

Build a list of AddCommerceItemInfos obtained from the ResourceUpdateInfos.

Parameters:

pAddUpdateInfos - a list of ResourceUpdateInfo detailing the operations to be performed.

Returns:

array of AddCommerceItemInfo objects

getUpdateData

protected java.util.Map<java.lang.String,java.lang.String> getUpdateData(java.util.List<atg.service.jaxrs.ResourceUpdateInfo> pResourceUpdateInfos)

Builds a map with details of the quantities of the commerce items for update. This information is extracted from the given list of ResourceUpdateInfos.

The map itself has a key of commerce item id and value of quantity.

Parameters:

pResourceUpdateInfos - a list of ResourceUpdateInfos containing data for update

Returns:

a map of commerce ids -> quantities

getUpdateData

protected java.util.Map<java.lang.String,java.lang.String> getUpdateData(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo,
                                                                         java.util.List<CommerceItem> pCommerceItems)

Builds a map with details of the quantity of commerce item for update. This information is extracted from the given ResourceUpdateInfo.

The map itself has a key of commerce item id and value of quantity.

A list of commerce items are also supplied in order to preserve them during the update. This is due to the underlying logic executed in the form handler call for update.

Parameters:

pUpdateInfo - contains details of the resource being updated

pCommerceItems - a list of the other commerce items that exist in the order

Returns:

a map of commerce ids -> quantities

populateDataForUpdate

protected void populateDataForUpdate(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo,
                                     java.util.Map<java.lang.String,java.lang.String> pDataForUpdate)

Populates the given map with details of the quantity of commerce item for update. This information is extracted from the given ResourceUpdateInfo.

The pDataForUpdate map itself has a key of commerce item id and value of quantity. The quantity is stored as a String in order for the associated form handler to interpret it correctly.

The following actions occur, based on the update type:

• ADDED : Ignored.
• REMOVED : The quantity will be set to zero as this has the effect of removing the commerce item from the cart.
• CHANGED : Set the amount depending on whether the commerce item allows a fractional quantity or not.

Parameters:

pUpdateInfo - contains details of the resource being updated

pDataForUpdate - a map of commerce id to (String) quantity

addInputsForAddItem

protected void addInputsForAddItem(FormHandlerExecutor pExecutor,
                                   Order pOrder,
                                   org.json.JSONObject pInputJson,
                                   atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo,
                                   AddCommerceItemInfo[] pItemsToAdd)
                            throws javax.servlet.ServletException,
                                   CommerceException

This method provides a place from which to add form handler input during the add item operation. Out of the box, the form handler properties that are set are:

• order
• addItemCount
• items
• shippingGroup (optional)

Note - the pItemsToAdd array is built using the getItemsToAdd(List) and buildAddCommerceItemInfo(ResourceUpdateInfo) methods. To ensure additional AddCommerceItemInfo properties get set, see buildAddCommerceItemInfo(ResourceUpdateInfo).

To add additional input, call one of the variants of FormHandlerExecutor.addInput(String, Object).

Parameters:

pExecutor - the form handler executor to which the input should be added

pOrder - the order to which we want to add the commerce item

pInputJson - representation of the item to be added

pResourceUpdateInfo - the resource update info representing the item to be added

pItemsToAdd - the items to add, in a format that that form handler understands

Throws:

javax.servlet.ServletException - if a problem occurred whilst adding input to the executor

CommerceException - if a shipping group could not be set on the order

addInputsForUpdateItems

protected void addInputsForUpdateItems(FormHandlerExecutor pExecutor,
                                       Order pOrder,
                                       atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo)
                                throws javax.servlet.ServletException

This method provides a place from which to add form handler input during the update item operation. Out of the box, the form handler properties that are set are:

• order

Additional information is set in the request in a key-value pair format. The key being the commerce item id and the value being the quantity.

To add additional input, call one of the variants of FormHandlerExecutor.addInput(String, Object).

Parameters:

pExecutor - the form handler executor to which the input should be added

pOrder - the order for which we want to update the commerce items

pResourceUpdateInfo - the resource update info representing the items to be updated

Throws:

javax.servlet.ServletException - if a problem occurred whilst adding input to the executor

addInputsForDeleteItem

protected void addInputsForDeleteItem(FormHandlerExecutor pExecutor,
                                      Order pOrder,
                                      java.lang.String pCommerceItemId)
                               throws javax.servlet.ServletException

This method provides a place from which to add form handler input during the delete item operation. Out of the box, the form handler properties that are set are:

• order
• removalCommerceIds

To add additional input, call one of the variants of FormHandlerExecutor.addInput(String, Object).

Parameters:

pExecutor - the form handler executor to which the input should be added

pOrder - the order from which we want to delete a commerce item

pCommerceItemId - id of the commerce that should be deleted

Throws:

javax.servlet.ServletException - if a problem occurred whilst adding input to the executor

getCreatedItemUri

protected java.net.URI getCreatedItemUri(FormHandlerExecutor pExecutor)

Build a URI to the newly added/created CommerceItem if present. Using the FormHandlerExecutor obtain the underlying CartModifierFormHandler. The CartModifierFormHandler maintains a list of commerce items that were created as part of an add operation, CartModifierFormHandler.getAddItemsToOrderResult();

Parameters:

pExecutor - - FormHandlerExecutor used in the execution of a given form handler handle operation.

Returns:

URI to newly created CommerceItem else null to indicate no item was added/created.