atg.commerce.order.restresources

Class CartShippingGroupRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractCommerceIdentifierRestSubresource

atg.commerce.order.restresources.ShippingGroupRestSubresource

atg.commerce.order.restresources.CartShippingGroupRestSubresource

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.CartShippingGroupRestSubresource")
public class CartShippingGroupRestSubresource
extends ShippingGroupRestSubresource
implements UpdateableRestResource

Subresource class provides the shipping group related endpoints for the cart parent resource. The endpoints in this resource class can only be applied on the current order shipping groups.

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
static java.lang.String	QUANTITY
static java.lang.String	RELATIONSHIPS
static java.lang.String	SHIPPING_GROUP_ID

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

ERR_SHIPPING_GROUP_NOT_FOUND

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

Method Summary

Modifier and Type	Method and Description
RepresentationModel	addShippingGroup(org.json.JSONObject pInputJson) Add a new shipping group to the current order.
java.lang.Object	deleteShippingGroup(java.lang.String pShippingGroupId) Removes the shippingGroup from the current order based on the shippingGroupId As the sub-resource delete can affect the top-level resource details, e.g.
CommerceItemManager	getCommerceItemManager() returns the commerce item manager
RepresentationModel	relateToItems(org.json.JSONObject pInputJson) Creates/modifies relationships between commerce items and shipping groups.
void	setCommerceItemManager(CommerceItemManager pCommerceItemManager) sets the commerce item manager
java.net.URI	update(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo) Updates the ShippingGroups in the Cart.
protected void	updateOrder(Order pOrder) Updates the order
RepresentationModel	updateShippingGroup(java.lang.String pShippingGroupId, org.json.JSONObject pInputJson) Updates a shipping group associated with the current order
RepresentationModel	updateShippingGroups(org.json.JSONObject pInputJson) This endpoint removes, updates or creates the shipping groups as part of the collection update.

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

checkShippingGroupIsAvailableForOrder, getOrderManager, getShippingGroup, getShippingGroup, getShippingGroupManager, getShippingGroups, getShippingMethods, setOrderManager, setShippingGroupManager

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

addCreatedItemUri, buildMemberUris, getCartUri, getCreatedItemUri, getDefaultLimit, getEmbeddedCartRelationshipName, getEmbeddedCommerceItemRelationshipName, getEmbeddedPaymentGroupRelationshipName, getEmbeddedShippingGroupRelationshipName, getOrder, getRelationshipCreated, getRelationships, getRepresentationModelBuilder, 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

SHIPPING_GROUP_ID

public static final java.lang.String SHIPPING_GROUP_ID

See Also:

Constant Field Values

COMMERCE_ITEM_ID

public static final java.lang.String COMMERCE_ITEM_ID

See Also:

Constant Field Values

RELATIONSHIPS

public static final java.lang.String RELATIONSHIPS

See Also:

Constant Field Values

QUANTITY

public static final java.lang.String QUANTITY

See Also:

Constant Field Values

Constructor Detail

CartShippingGroupRestSubresource

public CartShippingGroupRestSubresource()

Method Detail

getCommerceItemManager

public CommerceItemManager getCommerceItemManager()

returns the commerce item manager

Returns:

the commerce item manager

setCommerceItemManager

public void setCommerceItemManager(CommerceItemManager pCommerceItemManager)

sets the commerce item manager

Parameters:

pCommerceItemManager - new commerce item manager

addShippingGroup

@Endpoint(id="/shippingGroups#POST",
          validatorId="shippingGroups.id-FullWithCart",
          updateTarget=true)
public RepresentationModel addShippingGroup(org.json.JSONObject pInputJson)
                                                                                                                                                               throws RestException,
                                                                                                                                                                      CommerceException

Add a new shipping group to the current order.

Parameters:

pInputJson - A JSONObject that contains the ShippingGroupType (type - eg hardgoodShippingGroup, electronicShippingGroup) and subsequent details that are specific for that particular type

Returns:

RepresentationalModel of the newly added ShippingGroup

Throws:

RestException - if any internal error occurs whilst adding a new shipping group

CommerceException - if any internal error occurs whilst adding a new shipping group

deleteShippingGroup

@Endpoint(id="/shippingGroups/{shippingGroupId}#DELETE",
          isSingular=true,
          filterId="shippingGroups-Delete")
public java.lang.Object deleteShippingGroup(java.lang.String pShippingGroupId)
                                                                                                                                                                     throws RestException,
                                                                                                                                                                            CommerceException

Removes the shippingGroup from the current order based on the shippingGroupId 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. Most customers will not need this so ootb only filter/display the cart summary.

Parameters:

pShippingGroupId - Id of the shippingGroup to be removed from the current order

Returns:

a RepresentationModel if the shipping group is successfully removed from the order

Throws:

RestException - if any internal error occurs while removing the shippingGroup

CommerceException - if any error removing the shippingGroup from the current order

updateShippingGroup

@PATCH
 @Endpoint(id="/shippingGroups/{shippingGroupId}#PATCH",
          isSingular=true,
          validatorId="shippingGroups.id-Full",
          filterId="shippingGroups.id-FullWithCart",
          updateTarget=true)
public RepresentationModel updateShippingGroup(java.lang.String pShippingGroupId,
                                                                                                                                                                                                                                                                            org.json.JSONObject pInputJson)
                                                                                                                                                                                                                                                                     throws RestException,
                                                                                                                                                                                                                                                                            CommerceException

Updates a shipping group associated with the current order

Parameters:

pShippingGroupId - id of shipping group to update

pInputJson - representation of shipping group updates to apply

Returns:

the representation model containing the updated shipping group

Throws:

RestException - if an internal server error occurs while updating the shipping group

CommerceException

updateShippingGroups

@PATCH
 @Endpoint(id="/shippingGroups#PATCH",
          validatorId="shippingGroups-Full",
          filterId="shippingGroups-DefaultWithCart",
          updateTarget=true)
public RepresentationModel updateShippingGroups(org.json.JSONObject pInputJson)
                                                                                                                                                                                                                      throws RestException,
                                                                                                                                                                                                                             CommerceException

This endpoint removes, updates or creates the shipping groups as part of the collection update. Items in the collection containing the id property along with some other properties are considered for update, items containing all the required properties except the id are considered for create and all other the items are removed from the collection.

Parameters:

pInputJson - JSON representation of the shipping groups to be updated

Returns:

the representation model containing the updated list of shipping groups

Throws:

RestException - if an internal server error occurs while updating the shipping groups in the order

CommerceException - if an internal server error occurs while updating the shipping groups in the order

relateToItems

@Endpoint(id="/shippingGroups/relateToItems#POST",
          linkRelation="relateToItems",
          validatorId="shippingGroups.relateToItems",
          filterId="shippingGroups-DefaultWithCart",
          updateTarget=true)
public RepresentationModel relateToItems(org.json.JSONObject pInputJson)
                                                                                                                                                                                                                                                                     throws RestException,
                                                                                                                                                                                                                                                                            CommerceException

Creates/modifies relationships between commerce items and shipping groups. If a relationship already exists, this method will update that relationship, setting it's quantity to the quantity value provided in the input data. A quantity value of -1 indicates that the relationship should be a quantity remaining relationship. Specifically, this means that any un-assigned quantity of the commerce item should be added to the specified shipping group. A quantity value of 0 has the effect of removing an existing relationship.

 
 {
  "relationships" : [
   {
    "commerceItemId" : "ci5436",
    "shippingGroupId" : "sg3943",
    "quantity" : 2
   },
   {
    "commerceItemId" : "ci9349",
    "shippingGroupId" : "sg2293",
    "quantity" : 9
   },
   ...
  ]
 }
 
 

Parameters:

pInputJson - A JSONObject that contains the relationships to setup/modify.

Returns:

RepresentationalModel of the Order's ShippingGroups.

Throws:

RestException - if an error with the input data, e.g. missing data

CommerceException - if any internal error occurs while creating/updating commerce item to shipping group relationship

update

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

Updates the ShippingGroups in the Cart.

Specified by:

update in interface UpdateableRestResource

Parameters:

pUpdateInfo - - update object containing request input and any existing repository (shipping groups) 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

updateOrder

protected void updateOrder(Order pOrder)
                    throws CommerceException

Updates the order

Parameters:

pOrder - the current order to be updated

Throws:

CommerceException - if an error occurs while updating the Order