atg.commerce.order.restresources

Class CartRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractOrderRestResource

atg.commerce.order.restresources.CartRestResource

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

@RestResource(id="atg.commerce.order.restresources.CartRestResource")
public class CartRestResource
extends AbstractOrderRestResource
implements LockKeyProvider, UpdateableRestResource

This class provides endpoints for Cart related resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	ERR_CART_HAS_NO_CURRENT_ORDER
static java.lang.String	ERR_NO_RESOURCE_LOCK_KEY_AVAILABLE
protected atg.commerce.order.CartStateService	mCartStateService
static java.lang.String	NULL_ORDER_HOLDER
static java.lang.String	SALES_CHANNEL
static java.lang.String	SITE_ID
static java.lang.String	SUBRESOURCE_CLOSENESS_QUALIFIERS
static java.lang.String	SUBRESOURCE_COMMERCE_ITEMS
static java.lang.String	SUBRESOURCE_PAYMENT_GROUP
static java.lang.String	SUBRESOURCE_PAYMENT_GROUP_COMMERCE_ITEM_RELATIONSHIP
static java.lang.String	SUBRESOURCE_PAYMENT_GROUP_ORDER_RELATIONSHIP
static java.lang.String	SUBRESOURCE_PAYMENT_GROUP_SHIPPING_GROUP_RELATIONSHIP
static java.lang.String	SUBRESOURCE_SHIPPING_GROUP
static java.lang.String	SUBRESOURCE_SHIPPING_GROUP_COMMERCE_ITEM_RELATIONSHIP

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

COLON, mEmbeddedAppliedPromotionsRelationshipName, mEmbeddedResources, mGWPChoicesRelationshipName, mGwpManager, mOrderGWPInfoRelationshipName, mOrderManager, mTransactionManager, ORDER_ID, PIPELINE_RESULT, 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
CartRestResource()

Method Summary

Modifier and Type	Method and Description
protected void	addInputsForCancelOrder(FormHandlerExecutor pExecutor) This method provides a place from which to add form handler input during the cancel order operation.
protected void	addInputsForCommitOrder(FormHandlerExecutor pExecutor, Order pOrder, java.lang.Boolean pAllowEmptyOrders) This method provides a place from which to add form handler input during the commit order operation.
protected void	addInputsForExpressCheckout(FormHandlerExecutor pExecutor, java.lang.Boolean pCommitOrder) This method provides a place from which to add form handler input during the express checkout operation.
protected void	addInputsForMakeGiftSelection(FormHandlerExecutor pExecutor, atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo) This method provides a place from which to add form handler (GiftWithPurchaseFormHandler) input during the make gift selection operation.
protected void	addInputsForRemoveSelectableGWPQuantity(FormHandlerExecutor pExecutor, atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo) This method provides a place from which to add form handler (GiftWithPurchaseFormHandler) input during the remove selectable (gift) quantity operation.
RepresentationModel	cancelCart() Cancel the current order.
RepresentationModel	checkout(java.lang.Boolean pAllowEmptyOrders, org.json.JSONObject pInputJson) This endpoint checks out the shopping cart.
RepresentationModel	expressCheckout(java.lang.Boolean pCommitOrder) Conduct an express checkout for the shopping cart.
java.lang.String	getCancelCurrentOrderHandleMethod() Gets the name of the CancelOrderFormHandlerPath method that is called for handling the cancelling of the current order.
java.lang.String	getCancelOrderFormHandlerPath() Get the cancel order form handler path.
RepresentationModel	getCart() Returns a representation of the current order.
atg.commerce.order.CartStateService	getCartStateService() Sets the CartStateService property.
java.lang.Object	getClosenessQualifiers() Returns the closeness qualifier sub resource.
java.lang.Object	getCommerceItems() Returns the Commerce Items subresource.
java.lang.String	getCommitOrderFormHandlerPath() Get the commit order form handler path.
java.lang.String	getCommitOrderHandleMethod() Gets the name of the CommitOrderHandleMethod method that is called for handling the committing of the current order.
java.lang.String	getExpressCheckoutFormHandlerPath() Get the express checkout form handler path.
java.lang.String	getExpressCheckoutHandleMethod() Gets the name of the ExpressCheckoutFormHandler method that is called for handling the express checkout of the cart.
java.lang.String	getGiftWithPurchaseFormHandlerPath() Get the gift with purchase form handler path.
java.io.Serializable	getLockKey() Provide the resource lock key.
java.lang.String	getMakeGiftSelectionHandleMethod() Gets the name of the GiftWithPurchaseFormHandlerPath method that is called for handling the making of a gift selection
java.lang.Object	getPaymentGroupCommerceItemRelationships() Returns the PaymentGroupCommerceItemRelationship sub resource.
java.lang.Object	getPaymentGroupOrderRelationships() Returns the PaymentGroupOrderRelationship sub resource.
java.lang.Object	getPaymentGroups() Returns the PaymentGroup subresource.
java.lang.Object	getPaymentGroupShippingGroupRelationships() Returns the PaymentGroupShippingGroupRelationship sub resource.
java.lang.String	getRemoveSelectableQuantityHandleMethod() Gets the name of the GiftWithPurchaseFormHandlerPath method that is called for handling the removal of selectable (gift) quantity
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.String pOrderId) Gets the RepresentationModel.Builder for the given order.
java.lang.String	getRepriceOrderDropletPath() Gets the RepriceOrderDroplet path.
java.lang.Object	getShippingGroupCommerceItemRelationships() Returns the ShippingGroupCommerceItemRelationship sub resource.
java.lang.Object	getShippingGroups() Returns the ShippingGroup subresource.
protected OrderHolder	getShoppingCart() Returns the shopping cart associated with the current request.
java.lang.String	getShoppingCartPath() Get the shopping cart path
boolean	isStateless() Flag indicating if endpoints running stateless
RepresentationModel	makeGWPSelection(java.lang.Object pInputData) This endpoint enables the selection of a gift item, based on a qualified Gift with Purchase promotion.
RepresentationModel	removeSelectableGWPQuantity(java.lang.Object pInputData) This endpoint removes a specific quantity of 'available selectable quantity' for an existing gift in the current order.
RepresentationModel	reprice(org.json.JSONObject pInputJson) This endpoint reprices the shopping cart.
void	seRemoveSelectableQuantityHandleMethod(java.lang.String pRemoveSelectableQuantityHandleMethod) Sets the name of the RemoveSelectableQuantityHandleMethod method that is called for handling the removal of selectable (gift) quantity.
void	setCancelCurrentOrderHandleMethod(java.lang.String pCancelCurrentOrderHandleMethod) Sets the name of the CancelOrderHandleMethod method that is called for handling the cancelling of the current order.
void	setCancelOrderFormHandlerPath(java.lang.String pCancelOrderFormHandlerPath) Set the cancel order form handler path.
void	setCartStateService(atg.commerce.order.CartStateService pCartStateService) Sets the CartStateService property.
void	setCommitOrderFormHandlerPath(java.lang.String pCommitOrderFormHandlerPath) Set the commit order form handler path.
void	setCommitOrderHandleMethod(java.lang.String pCommitOrderHandleMethod) Sets the name of the CommitOrderHandleMethod method that is called for handling the committing of the current order.
void	setExpressCheckoutFormHandlerPath(java.lang.String pExpressCheckoutFormHandlerPath) Set the express checkout form handler path.
void	setExpressCheckoutHandleMethod(java.lang.String pExpressCheckoutHandleMethod) Sets the name of the ExpressCheckoutFormHandler method that is called for handling the express checkout of the cart.
void	setGiftWithPurchaseFormHandlerPath(java.lang.String pGiftWithPurchaseFormHandlerPath) Set the gift with purchase form handler path.
void	setMakeGiftSelectionHandleMethod(java.lang.String pMakeGiftSelectionHandleMethod) Sets the name of the MakeGiftSelectionHandleMethod method that is called for handling the making of a gift selection
void	setRepriceOrderDropletPath(java.lang.String pRepriceOrderDropletPath) Sets the RepriceOrderDroplet path.
void	setShoppingCartPath(java.lang.String pShoppingCartPath) Set the shopping cart path
void	setStateless(boolean pStateless) Flag indicating if endpoints running stateless
protected void	setupCartStateRequestData() This method adds the current order to the request data map See CartStateService.setupCartStateRequestData
protected void	setupRequestData(java.lang.String pSubresourceType) Sets up request data for Subresources to utilise.
java.net.URI	update(atg.service.jaxrs.ResourceUpdateInfo pRestResourceUpdateInfo) This method specifically handles updates to any embedded resources, all contained with pRestResourceUpdateInfo.
RepresentationModel	updateCart(org.json.JSONObject pInputJson) Updates the current Order in the Shopping Cart.

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

addEmbeddedResource, addEmbeddedResources, addEmbeddedResources, addGiftWithPurchaseChoicesLinks, checkPipelineResult, checkPipelineResult, createRepresentationModelBuilder, getEmbeddedAppliedPromotionsRelationshipName, getEmbeddedResources, getGWPChoicesRelationshipName, getGwpManager, getOrderGWPInfoRelationshipName, getOrderManager, getRepresentationModelBuilder, getTransactionManager, setEmbeddedAppliedPromotionsRelationshipName, setEmbeddedResources, setGWPChoicesRelationshipName, setGwpManager, setOrderGWPInfoRelationshipName, setOrderManager, setTransactionManager

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

SITE_ID

public static final java.lang.String SITE_ID

See Also:

Constant Field Values

SALES_CHANNEL

public static final java.lang.String SALES_CHANNEL

See Also:

Constant Field Values

SUBRESOURCE_COMMERCE_ITEMS

public static final java.lang.String SUBRESOURCE_COMMERCE_ITEMS

See Also:

Constant Field Values

SUBRESOURCE_CLOSENESS_QUALIFIERS

public static final java.lang.String SUBRESOURCE_CLOSENESS_QUALIFIERS

See Also:

Constant Field Values

SUBRESOURCE_PAYMENT_GROUP

public static final java.lang.String SUBRESOURCE_PAYMENT_GROUP

See Also:

Constant Field Values

SUBRESOURCE_PAYMENT_GROUP_COMMERCE_ITEM_RELATIONSHIP

public static final java.lang.String SUBRESOURCE_PAYMENT_GROUP_COMMERCE_ITEM_RELATIONSHIP

See Also:

Constant Field Values

SUBRESOURCE_PAYMENT_GROUP_ORDER_RELATIONSHIP

public static final java.lang.String SUBRESOURCE_PAYMENT_GROUP_ORDER_RELATIONSHIP

See Also:

Constant Field Values

SUBRESOURCE_PAYMENT_GROUP_SHIPPING_GROUP_RELATIONSHIP

public static final java.lang.String SUBRESOURCE_PAYMENT_GROUP_SHIPPING_GROUP_RELATIONSHIP

See Also:

Constant Field Values

SUBRESOURCE_SHIPPING_GROUP

public static final java.lang.String SUBRESOURCE_SHIPPING_GROUP

See Also:

Constant Field Values

SUBRESOURCE_SHIPPING_GROUP_COMMERCE_ITEM_RELATIONSHIP

public static final java.lang.String SUBRESOURCE_SHIPPING_GROUP_COMMERCE_ITEM_RELATIONSHIP

See Also:

Constant Field Values

ERR_CART_HAS_NO_CURRENT_ORDER

public static final java.lang.String ERR_CART_HAS_NO_CURRENT_ORDER

See Also:

Constant Field Values

ERR_NO_RESOURCE_LOCK_KEY_AVAILABLE

public static final java.lang.String ERR_NO_RESOURCE_LOCK_KEY_AVAILABLE

See Also:

Constant Field Values

NULL_ORDER_HOLDER

public static final java.lang.String NULL_ORDER_HOLDER

See Also:

Constant Field Values

mCartStateService

protected atg.commerce.order.CartStateService mCartStateService

Constructor Detail

CartRestResource

public CartRestResource()

Method Detail

setStateless

public void setStateless(boolean pStateless)

Flag indicating if endpoints running stateless

Parameters:

pStateless - boolean flag

isStateless

public boolean isStateless()

Flag indicating if endpoints running stateless

Returns:

boolean Flag indicating stateless status

getShoppingCartPath

public java.lang.String getShoppingCartPath()

Get the shopping cart path

Returns:

A nucleus path to the shopping cart component.

setShoppingCartPath

public void setShoppingCartPath(java.lang.String pShoppingCartPath)

Set the shopping cart path

Parameters:

pShoppingCartPath - nucleus path to the shopping cart component.

getExpressCheckoutFormHandlerPath

public java.lang.String getExpressCheckoutFormHandlerPath()

Get the express checkout form handler path.

Returns:

A nucleus path to the express checkout form handler component.

setExpressCheckoutFormHandlerPath

public void setExpressCheckoutFormHandlerPath(java.lang.String pExpressCheckoutFormHandlerPath)

Set the express checkout form handler path.

Parameters:

pExpressCheckoutFormHandlerPath - a nucleus path to the express checkout form handler component.

getExpressCheckoutHandleMethod

public java.lang.String getExpressCheckoutHandleMethod()

Gets the name of the ExpressCheckoutFormHandler method that is called for handling the express checkout of the cart.

The default value is "expressCheckout".

Returns:

the express checkout handle method

setExpressCheckoutHandleMethod

public void setExpressCheckoutHandleMethod(java.lang.String pExpressCheckoutHandleMethod)

Sets the name of the ExpressCheckoutFormHandler method that is called for handling the express checkout of the cart.

Parameters:

pExpressCheckoutHandleMethod - the name of the express checkout handle method

getCancelOrderFormHandlerPath

public java.lang.String getCancelOrderFormHandlerPath()

Get the cancel order form handler path.

Returns:

A nucleus path to the cancel order form handler component.

setCancelOrderFormHandlerPath

public void setCancelOrderFormHandlerPath(java.lang.String pCancelOrderFormHandlerPath)

Set the cancel order form handler path.

Parameters:

pCancelOrderFormHandlerPath - a nucleus path to the cancel order form handler component.

getCancelCurrentOrderHandleMethod

public java.lang.String getCancelCurrentOrderHandleMethod()

Gets the name of the CancelOrderFormHandlerPath method that is called for handling the cancelling of the current order.

The default value is "cancelCurrentOrder".

Returns:

the cancel current order handle method

setCancelCurrentOrderHandleMethod

public void setCancelCurrentOrderHandleMethod(java.lang.String pCancelCurrentOrderHandleMethod)

Sets the name of the CancelOrderHandleMethod method that is called for handling the cancelling of the current order.

Parameters:

pCancelCurrentOrderHandleMethod - the name of the cancel current order handle method

getCommitOrderFormHandlerPath

public java.lang.String getCommitOrderFormHandlerPath()

Get the commit order form handler path.

Returns:

A nucleus path to the commit order form handler component.

setCommitOrderFormHandlerPath

public void setCommitOrderFormHandlerPath(java.lang.String pCommitOrderFormHandlerPath)

Set the commit order form handler path.

Parameters:

pCommitOrderFormHandlerPath - a nucleus path to the commit order form handler component.

getCommitOrderHandleMethod

public java.lang.String getCommitOrderHandleMethod()

Gets the name of the CommitOrderHandleMethod method that is called for handling the committing of the current order.

The default value is "commitOrder".

Returns:

the commit current order handle method

setCommitOrderHandleMethod

public void setCommitOrderHandleMethod(java.lang.String pCommitOrderHandleMethod)

Sets the name of the CommitOrderHandleMethod method that is called for handling the committing of the current order.

Parameters:

pCommitOrderHandleMethod - the name of the commit order handle method

getGiftWithPurchaseFormHandlerPath

public java.lang.String getGiftWithPurchaseFormHandlerPath()

Get the gift with purchase form handler path.

Returns:

A nucleus path to the gift with purchase form handler component.

setGiftWithPurchaseFormHandlerPath

public void setGiftWithPurchaseFormHandlerPath(java.lang.String pGiftWithPurchaseFormHandlerPath)

Set the gift with purchase form handler path.

Parameters:

pGiftWithPurchaseFormHandlerPath - a nucleus path to the gift with purchase form handler component.

getMakeGiftSelectionHandleMethod

public java.lang.String getMakeGiftSelectionHandleMethod()

Gets the name of the GiftWithPurchaseFormHandlerPath method that is called for handling the making of a gift selection

The default value is "makeGiftSelection".

Returns:

the make gift selection handle method

setMakeGiftSelectionHandleMethod

public void setMakeGiftSelectionHandleMethod(java.lang.String pMakeGiftSelectionHandleMethod)

Sets the name of the MakeGiftSelectionHandleMethod method that is called for handling the making of a gift selection

Parameters:

pMakeGiftSelectionHandleMethod - the name of the make gift selection handle method

getRemoveSelectableQuantityHandleMethod

public java.lang.String getRemoveSelectableQuantityHandleMethod()

Gets the name of the GiftWithPurchaseFormHandlerPath method that is called for handling the removal of selectable (gift) quantity

The default value is "removeSelectableQuantity".

Returns:

the remove selectable quantity handle method

seRemoveSelectableQuantityHandleMethod

public void seRemoveSelectableQuantityHandleMethod(java.lang.String pRemoveSelectableQuantityHandleMethod)

Sets the name of the RemoveSelectableQuantityHandleMethod method that is called for handling the removal of selectable (gift) quantity.

Parameters:

pRemoveSelectableQuantityHandleMethod - the name of the remove selectable (gift) quantity handle method

getRepriceOrderDropletPath

public java.lang.String getRepriceOrderDropletPath()

Gets the RepriceOrderDroplet path.

Returns:

A nucleus path to the RepriceOrderDroplet component.

setRepriceOrderDropletPath

public void setRepriceOrderDropletPath(java.lang.String pRepriceOrderDropletPath)

Sets the RepriceOrderDroplet path.

Parameters:

pRepriceOrderDropletPath - a nucleus path to RepriceOrderDroplet component.

getShoppingCart

protected OrderHolder getShoppingCart()

Returns the shopping cart associated with the current request.

Returns:

The order holder which represents the shopping cart.

setCartStateService

public void setCartStateService(atg.commerce.order.CartStateService pCartStateService)

Sets the CartStateService property. CartStateService to be used when adding the state of the cart to the request.

Parameters:

pCartStateService - the CartStateService property

getCartStateService

public atg.commerce.order.CartStateService getCartStateService()

Sets the CartStateService property. CartStateService to be used when adding the state of the cart to the request.

Returns:

the CartStateService

getCart

@Hidden
 @Endpoint(id="/cart/#GET",
          isSingular=true,
          filterId="cart-Default")
public RepresentationModel getCart()
                                                                                                                              throws RestException,
                                                                                                                                     CommerceException

Returns a representation of the current order.

Returns:

RepresentationModel representing the Order

Throws:

RestException - if a problem occurs retrieving the Order

CommerceException - if a problem occurs processing of the Order

expressCheckout

@Endpoint(id="/cart/expressCheckout/#POST",
          isSingular=true,
          filterId="cart-Default")
public RepresentationModel expressCheckout(java.lang.Boolean pCommitOrder)
                                                                                                                                              throws RestException,
                                                                                                                                                     CommerceException,
                                                                                                                                                     javax.servlet.ServletException

Conduct an express checkout for the shopping cart. For expressCheckout to be allowed the following conditions must be true:

1. The customer is logged in
2. The customer has a default shipping method
3. The customer has a valid default shipping address
4. The customer has a valid default credit card

Parameters:

pCommitOrder - true if the order should be committed immediately, or false if the order should be prepared but not committed, or omitted to use the configured value of ExpressCheckoutFormHandler.commitOrder.

Returns:

RepresentationModel representing the Order.

Throws:

RestException - if a problem occurs retrieving the Order.

CommerceException - if a problem occurs processing of the Order.

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

cancelCart

@Endpoint(id="/cart/DELETE",
          isSingular=true,
          filterId="cart-Default")
public RepresentationModel cancelCart()
                                                                                                                          throws RestException,
                                                                                                                                 CommerceException,
                                                                                                                                 javax.servlet.ServletException

Cancel the current order.

Returns:

an empty representation model of the cart.

Throws:

RestException - if an internal server error occurs attempting to cancel the order

CommerceException - if a problem occurs processing of the Order

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

reprice

@Endpoint(id="/cart/reprice/#POST",
          isSingular=true,
          validatorId="cart.reprice",
          filterId="cart-Default")
public RepresentationModel reprice(org.json.JSONObject pInputJson)
                                                                                                                                                                    throws RestException,
                                                                                                                                                                           CommerceException

This endpoint reprices the shopping cart.

The optional "pricingOperation" parameter can be used to control the type of pricing that takes place. If no pricingOperation parameter is supplied then the default is to price the order fully, including tax."

The pricingOperation value provided should be one of the following :

1. order_total : Reprice the whole order, including items, shipping and taxes.
2. order_subtotal : Reprice items and calculate order subtotal.
3. order_subtotal_shipping : Reprice items and calculate order subtotal and shipping, not taxes.
4. order_subtotal_tax : Reprice items and calculate order subtotal and taxes, not shipping.
5. items : Price items.
6. shipping : Price shipping.
7. order : Price order.
8. tax : Price taxes.

Parameters:

pInputJson - input json

Returns:

RepresentationModel representing the Order.

Throws:

RestException - if an internal server error occurs attempting to reprice the order.

CommerceException - if a problem occurs processing of the Order

checkout

@Endpoint(id="/cart/checkout/#POST",
          isSingular=true,
          validatorId="cart.checkout",
          filterId="cart-Default")
public RepresentationModel checkout(java.lang.Boolean pAllowEmptyOrders,
                                                                                                                                                                              org.json.JSONObject pInputJson)
                                                                                                                                                                       throws RestException,
                                                                                                                                                                              CommerceException,
                                                                                                                                                                              javax.servlet.ServletException

This endpoint checks out the shopping cart.

Parameters:

pAllowEmptyOrders - true if empty orders should be allowed, false otherwise

pInputJson - JSON representing the shopping cart

Returns:

a representation of the checked out order

Throws:

RestException - if something went wrong during checkout

CommerceException - if a problem occurs processing of the Order

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

updateCart

@PATCH
 @Endpoint(id="/cart/#PATCH",
          isSingular=true,
          validatorId="cart-Default",
          filterId="cart-Default",
          updateTarget=true)
public RepresentationModel updateCart(org.json.JSONObject pInputJson)
                                                                                                                                                                                                     throws RestException,
                                                                                                                                                                                                            CommerceException,
                                                                                                                                                                                                            TransactionDemarcationException

Updates the current Order in the Shopping Cart.

Parameters:

pInputJson - JSON representation of the shopping cart.

Returns:

RepresentationModel representing the Order.

Throws:

RestException - if a problem occurs retrieving the Order.

CommerceException - if a problem occurs processing of the Order.

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

TransactionDemarcationException - if a problem occurs processing the Order.

makeGWPSelection

@Endpoint(id="/cart/makeGWPSelection/#POST",
          validatorId="cart.makeGWPSelection",
          filterId="cart-Default",
          isSingular=true)
public RepresentationModel makeGWPSelection(java.lang.Object pInputData)
                                                                                                                                                                                               throws CommerceException,
                                                                                                                                                                                                      javax.servlet.ServletException

This endpoint enables the selection of a gift item, based on a qualified Gift with Purchase promotion. Note: the replaceRemovedQuantity property enables available selectable quantity that has been explicitly removed by calling the /removeSelectableGWPQuantity endpoint to still be available/selectable. The property defaults to false if not passed in input.

 
  {
    "quantity":1,
    "giftWithPurchaseIdentifier":-1836123324,
    "productId":"xprod1010",
    "skuId":"xsku1038",
    "replaceRemovedQuantity": true
  }
 
 

Parameters:

pInputData - input data

Returns:

RepresentationModel representation of cart, including gift status (selectable quantity, etc)

Throws:

CommerceException - if an error occurs attempting to make a gift selection

javax.servlet.ServletException - if an error occurs attempting to make a gift selection

removeSelectableGWPQuantity

@Endpoint(id="/cart/removeSelectableGWPQuantity/#POST",
          validatorId="cart.removeSelectableGWPQuantity",
          filterId="cart-Default",
          isSingular=true)
public RepresentationModel removeSelectableGWPQuantity(java.lang.Object pInputData)
                                                                                                                                                                                                                                throws CommerceException,
                                                                                                                                                                                                                                       javax.servlet.ServletException

This endpoint removes a specific quantity of 'available selectable quantity' for an existing gift in the current order. If a gift offers, for example, quantity 3 free, this could be reduced to only offer quantity 2 by the call below.

Note: Only positive values are accepted, so once a gift quantity is reduced, it cannot be increased again, unless, for example, a shopper removes items, re-adds and re-qualifies for the gift afresh.

 
  {
    "quantityToRemove": 1,
    "giftWithPurchaseIdentifier": -1836123324
  }
 
 

Parameters:

pInputData - input data

Returns:

RepresentationModel representation of cart, including gift status (selectable quantity, etc)

Throws:

CommerceException - if an error occurs attempting to remove selectable gift quantity

javax.servlet.ServletException - if an error occurs attempting to remove selectable gift quantity

getCommerceItems

@Hidden
 @SubresourceLocator(subresourceIds="atg.commerce.order.restresources.CartCommerceItemRestSubresource")
public java.lang.Object getCommerceItems()
                                                                                                                                                  throws RestException

Returns the Commerce Items subresource.

Returns:

the Comemerce Items Subresource

Throws:

RestException - if a problem occurs obtaining the subresource

getPaymentGroups

@Hidden
 @SubresourceLocator(subresourceIds="atg.commerce.order.restresources.CartPaymentGroupRestSubresource")
public java.lang.Object getPaymentGroups()
                                                                                                                                                  throws RestException

Returns the PaymentGroup subresource.

Returns:

the Payment Group Subresource

Throws:

RestException - if a problem occurs obtaining the subresource

getPaymentGroupCommerceItemRelationships

@Hidden
 @SubresourceLocator(subresourceIds="atg.commerce.order.restresources.PaymentGroupCommerceItemRelationshipRestSubresource")
public java.lang.Object getPaymentGroupCommerceItemRelationships()
                                                                                                                                                                                              throws RestException

Returns the PaymentGroupCommerceItemRelationship sub resource.

Returns:

the paymentgroup commerce item relationship sub resource

Throws:

RestException - if any problem occurs obtaining the sub resource

getPaymentGroupOrderRelationships

@Hidden
 @SubresourceLocator(subresourceIds="atg.commerce.order.restresources.PaymentGroupOrderRelationshipRestSubresource")
public java.lang.Object getPaymentGroupOrderRelationships()
                                                                                                                                                                                throws RestException

Returns the PaymentGroupOrderRelationship sub resource.

Returns:

the paymentGroupOrderRelationship sub resource

Throws:

RestException - if any problem occurs obtaining the sub resource

getPaymentGroupShippingGroupRelationships

@Hidden
 @SubresourceLocator(subresourceIds="atg.commerce.order.restresources.PaymentGroupShippingGroupRelationshipRestSubresource")
public java.lang.Object getPaymentGroupShippingGroupRelationships()
                                                                                                                                                                                                throws RestException

Returns the PaymentGroupShippingGroupRelationship sub resource.

Returns:

the paymentGroupShippingGroupRelationship sub resource

Throws:

RestException - if any problem occurs obtaining the sub resource

getShippingGroupCommerceItemRelationships

@Hidden
 @SubresourceLocator(subresourceIds="atg.commerce.order.restresources.ShippingGroupCommerceItemRelationshipRestSubresource")
public java.lang.Object getShippingGroupCommerceItemRelationships()
                                                                                                                                                                                                throws RestException

Returns the ShippingGroupCommerceItemRelationship sub resource.

Returns:

the shipping group commerce item relationship sub resource

Throws:

RestException - if a problem occurs obtaining the sub resource

getShippingGroups

@Hidden
 @SubresourceLocator(subresourceIds="atg.commerce.order.restresources.CartShippingGroupRestSubresource")
public java.lang.Object getShippingGroups()
                                                                                                                                                    throws RestException

Returns the ShippingGroup subresource.

Returns:

the Shipping Group Subresource

Throws:

RestException - if a problem occurs obtaining the subresource

getClosenessQualifiers

@Hidden
 @SubresourceLocator(subresourceIds="atg.commerce.promotion.restresources.ClosenessQualifierRestSubresource")
public java.lang.Object getClosenessQualifiers()
                                                                                                                                                              throws RestException

Returns the closeness qualifier sub resource.

Returns:

The closeness qualifier sub resource.

Throws:

RestException - if there is a problem while retrieving the closeness qualifiers.

getLockKey

@Hidden
public java.io.Serializable getLockKey()
                                        throws RestException

Provide the resource lock key. The lock key is used by the REST framework to lock the cart resource from multiple updates that can lead to concurrency issues.

Specified by:

getLockKey in interface LockKeyProvider

Returns:

the resource lock key.

Throws:

RestException - if lock key cannot be obtained.

setupRequestData

protected void setupRequestData(java.lang.String pSubresourceType)
                         throws RestException

Sets up request data for Subresources to utilise.

Throws:

RestException

setupCartStateRequestData

protected void setupCartStateRequestData()

This method adds the current order to the request data map See CartStateService.setupCartStateRequestData

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.String pOrderId)

Gets the RepresentationModel.Builder for the given order. The Builder contains a self link and responseURI set, pointing to the singular GET of the OrderRestResource.

Parameters:

pOrderId - the order id from which the RepresentationModel.Builder links will be created for

Returns:

RepresentationModel.Builder containing the Builder with Order links

addInputsForCancelOrder

protected void addInputsForCancelOrder(FormHandlerExecutor pExecutor)
                                throws javax.servlet.ServletException

This method provides a place from which to add form handler input during the cancel order operation.

Parameters:

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

Throws:

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

addInputsForCommitOrder

protected void addInputsForCommitOrder(FormHandlerExecutor pExecutor,
                                       Order pOrder,
                                       java.lang.Boolean pAllowEmptyOrders)
                                throws javax.servlet.ServletException

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

• order
• allowEmptyOrders (optional)

Parameters:

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

pOrder - the order to be checked out

pAllowEmptyOrders - true if empty orders should be allowed, false otherwise

Throws:

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

addInputsForExpressCheckout

protected void addInputsForExpressCheckout(FormHandlerExecutor pExecutor,
                                           java.lang.Boolean pCommitOrder)
                                    throws javax.servlet.ServletException

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

• shippingGroupNeeded
• paymentGroupNeeded
• commitOrder (optional)

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

pCommitOrder - true if the order should be committed immediately, or false if the order should be prepared but not committed, or omitted to use the configured value of ExpressCheckoutFormHandler.commitOrder.

Throws:

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

addInputsForMakeGiftSelection

protected void addInputsForMakeGiftSelection(FormHandlerExecutor pExecutor,
                                             atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo)
                                      throws javax.servlet.ServletException,
                                             CommerceException

This method provides a place from which to add form handler (GiftWithPurchaseFormHandler) input during the make gift selection operation. Out of the box, the form handler properties that are set (if passed in pResourceUpdateInfo.getUpdates()) are:

• currentSelectedItemId
• promotionId
• giftHashCode
• productId
• skuId
• quantity
• quantityWithFraction
• replaceRemovedQuantity

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

pResourceUpdateInfo - a ResourceUpdateInfo containing data/input to be used during make gift selection

Throws:

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

CommerceException - if a problem occurs adding input to the executor

addInputsForRemoveSelectableGWPQuantity

protected void addInputsForRemoveSelectableGWPQuantity(FormHandlerExecutor pExecutor,
                                                       atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo)
                                                throws javax.servlet.ServletException,
                                                       CommerceException

This method provides a place from which to add form handler (GiftWithPurchaseFormHandler) input during the remove selectable (gift) quantity operation. Out of the box, the form handler properties that are set (if passed in pResourceUpdateInfo.getUpdates()) are:

• promotionId
• giftHashCode
• selectableQuantityToRemove
• selectableQuantityWithFractionToRemove

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

pResourceUpdateInfo - a ResourceUpdateInfo containing data/input to be used during remove selectable gift quantity

Throws:

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

CommerceException - if a problem occurs adding input to the executor

update

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

This method specifically handles updates to any embedded resources, all contained with pRestResourceUpdateInfo. It will call updateEmbeddedResources() to update any of the updateable resources configured on this resource.

Specified by:

update in interface UpdateableRestResource

Parameters:

pRestResourceUpdateInfo - - cart update object, containing update data (request inputs and any existing repository data) to be applied to its updateable embedded resources.

Returns:

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

Throws:

RestException - - if an issue occurs performing the update