atg.commerce.order.restresources

Class ShippingGroupRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractCommerceIdentifierRestSubresource

atg.commerce.order.restresources.ShippingGroupRestSubresource

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:

CartShippingGroupRestSubresource

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

Class that defines the RESTful endpoints for Shipping Groups

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	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
ShippingGroupRestSubresource()

Method Summary

Modifier and Type	Method and Description
protected void	checkShippingGroupIsAvailableForOrder(Order pOrder, java.lang.String pShippingGroupId) Check whether the shipping group is available in the ShippingGroup container.
OrderManager	getOrderManager() Returns property OrderManager
protected ShippingGroup	getShippingGroup(Order pOrder, java.lang.String pShippingGroupId) Retrieves a specific shipping group from an order.
RepresentationModel	getShippingGroup(java.lang.String pShippingGroupId) Endpoint that provides the Shipping Group for an Order based on its ID
ShippingGroupManager	getShippingGroupManager() Returns property ShippingGroupManager
RepresentationModel	getShippingGroups() Endpoint that provides the Shipping Groups for an Order
java.lang.Object	getShippingMethods(java.lang.String pOrderId, java.lang.String pShippingGroupId) Returns the ShippingMethod subresource.
void	setOrderManager(OrderManager pOrderManager) Sets property OrderManager
void	setShippingGroupManager(ShippingGroupManager pShippingGroupManager) Sets property ShippingGroupManager

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

ERR_SHIPPING_GROUP_NOT_FOUND

public static final java.lang.String ERR_SHIPPING_GROUP_NOT_FOUND

See Also:

Constant Field Values

Constructor Detail

ShippingGroupRestSubresource

public ShippingGroupRestSubresource()

Method Detail

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

Sets property OrderManager

Parameters:

pOrderManager - - the OrderManager object to set

getOrderManager

public OrderManager getOrderManager()

Returns property OrderManager

Returns:

OrderManager - the OrderManager component to be returned

setShippingGroupManager

public void setShippingGroupManager(ShippingGroupManager pShippingGroupManager)

Sets property ShippingGroupManager

Parameters:

pShippingGroupManager - - the ShippingGroupManager object to be set

getShippingGroupManager

public ShippingGroupManager getShippingGroupManager()

Returns property ShippingGroupManager

Returns:

ShippingGroupManager component

getShippingGroup

@Endpoint(id="/shippingGroups/{shippingGroupId}#GET",
          isSingular=true,
          filterId="shippingGroups.id-Default")
public RepresentationModel getShippingGroup(java.lang.String pShippingGroupId)
                                                                                                                                                                      throws CommerceException,
                                                                                                                                                                             RestException

Endpoint that provides the Shipping Group for an Order based on its ID

Parameters:

pShippingGroupId - the ShippingGroup Id

Returns:

model representation of the Shipping Group

Throws:

CommerceException - if the shipping group cannot be found

RestException - if there is a problem obtaining the shipping group information

getShippingGroups

@Endpoint(id="/shippingGroups/GET",
          filterId="shippingGroups-Default")
public RepresentationModel getShippingGroups()
                                                                                                                       throws RestException

Endpoint that provides the Shipping Groups for an Order

Returns:

model representation of the list of shipping groups

Throws:

RestException - if something went wrong whilst getting the shipping groups

getShippingMethods

@SubresourceLocator(subresourceIds="atg.commerce.order.restresources.ShippingMethodRestSubresource")
public java.lang.Object getShippingMethods(java.lang.String pOrderId,
                                                                                                                                                java.lang.String pShippingGroupId)
                                                                                                                                         throws RestException,
                                                                                                                                                CommerceException

Returns the ShippingMethod subresource.

Parameters:

pOrderId - the parent Order Id

pShippingGroupId - the ShippingGroup Id

Returns:

the Shipping Method subresource

Throws:

RestException - if a problem occurs obtaining the subresource

CommerceException - if the shippingGroupId is invalid

getShippingGroup

protected ShippingGroup getShippingGroup(Order pOrder,
                                         java.lang.String pShippingGroupId)
                                  throws CommerceException,
                                         RestException

Retrieves a specific shipping group from an order.

Parameters:

pOrder - The parent order

pShippingGroupId - The ID of the requested shipping group

Returns:

ShippingGroup The requested shipping group

Throws:

RestException - if there is a problem obtaining the shipping group

CommerceException - if the shippingGroupId is invalid

checkShippingGroupIsAvailableForOrder

protected void checkShippingGroupIsAvailableForOrder(Order pOrder,
                                                     java.lang.String pShippingGroupId)
                                              throws RestException

Check whether the shipping group is available in the ShippingGroup container. This method is used before retrieving/updating/deleting the shipping group in the current order

Parameters:

pOrder - the order containing the shipping groups

pShippingGroupId - Id of the payment group to be removed from the order

Throws:

RestException - with NOT_FOUND status if the shipping group is invalid