atg.commerce.order.restresources

Class OrderRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractOrderRestResource

atg.commerce.order.restresources.OrderRestResource

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

@RestResource(id="atg.commerce.order.restresources.OrderRestResource")
public class OrderRestResource
extends AbstractOrderRestResource

This class provides endpoints for Order related resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COMMA
static java.lang.String	ERR_NO_USER_ID_IN_REQUEST
static java.lang.String	FALSE
static java.lang.String	ITEM
static java.lang.String	TOTAL
static java.lang.String	TRUE

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

Method Summary

Modifier and Type	Method and Description
protected void	addToRequestCache(java.lang.String pOrderId) Request cache the Order for use by sub resources.
java.lang.Object	getCommerceItems(java.lang.String pOrderId) Returns the Commerce Items sub resource.
RepresentationModel	getOrder(java.lang.String pOrderId) Returns a representation of an Order for given order id.
javax.servlet.Servlet	getOrderLookupDroplet() Get the OrderLookupDroplet
java.lang.Object	getPaymentGroupCommerceItemRelationships(java.lang.String pOrderId) Returns the PaymentGroupCommerceItemRelationship sub resource.
java.lang.Object	getPaymentGroupOrderRelationships(java.lang.String pOrderId) Returns the PaymentGroupOrderRelationship sub resource.
java.lang.Object	getPaymentGroups(java.lang.String pOrderId) Returns the PaymentGroup subresource.
java.lang.Object	getPaymentGroupShippingGroupRelationships(java.lang.String pOrderId) Returns the PaymentGroupShippingGroupRelationship sub resource.
java.lang.String	getProfilePath() Returns property ProfilePath.
java.lang.Object	getShippingGroupCommerceItemRelationships(java.lang.String pOrderId) Returns the ShippingGroupCommerceItemRelationship sub resource.
java.lang.Object	getShippingGroups(java.lang.String pOrderId) Returns the ShippingGroup subresource.
boolean	isSecurityEnabled() Gets the property SecurityEnabled.
RepresentationModel	listOrders(java.lang.String pUserId, java.lang.String pState, java.lang.String pOpenStates, java.lang.String pClosedStates, java.lang.String pSiteIds, java.lang.String pOrganizationIds, java.lang.String pSiteScope, java.lang.String pOffset, java.lang.String pLimit, java.lang.String pOrderBy) Retrieves Orders for the current user.
protected Order	retrieveOrder(java.lang.String pOrderId) Retrieve the Order for the given Order Id.
void	setOrderLookupDroplet(javax.servlet.Servlet pOrderLookupDroplet) Sets the OrderLookupDroplet
void	setProfilePath(java.lang.String pProfilePath) Sets property ProfilePath.
void	setSecurityEnabled(boolean pSecurityEnabled) Sets the property SecurityEnabled.

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

ITEM

public static final java.lang.String ITEM

See Also:

Constant Field Values

TOTAL

public static final java.lang.String TOTAL

See Also:

Constant Field Values

ERR_NO_USER_ID_IN_REQUEST

public static final java.lang.String ERR_NO_USER_ID_IN_REQUEST

See Also:

Constant Field Values

COMMA

public static final java.lang.String COMMA

See Also:

Constant Field Values

FALSE

public static final java.lang.String FALSE

See Also:

Constant Field Values

TRUE

public static final java.lang.String TRUE

See Also:

Constant Field Values

Constructor Detail

OrderRestResource

public OrderRestResource()

Method Detail

setSecurityEnabled

public void setSecurityEnabled(boolean pSecurityEnabled)

Sets the property SecurityEnabled. If this is true, then users will only be able to view their own orders. If false then anyone can see any order.

Parameters:

pSecurityEnabled - flag to enable security checking

isSecurityEnabled

public boolean isSecurityEnabled()

Gets the property SecurityEnabled. If this is true, then users will only be able to view their own orders. If false then anyone can see any order.

Returns:

whether security is enabled

setProfilePath

public void setProfilePath(java.lang.String pProfilePath)

Sets property ProfilePath.

Parameters:

pProfilePath - path to the profile nucleus component. Usually atg/userprofiling/Profile

getProfilePath

public java.lang.String getProfilePath()

Returns property ProfilePath.

Returns:

the profile path

getOrderLookupDroplet

public javax.servlet.Servlet getOrderLookupDroplet()

Get the OrderLookupDroplet

Returns:

the OrderLookupDroplet

setOrderLookupDroplet

public void setOrderLookupDroplet(javax.servlet.Servlet pOrderLookupDroplet)

Sets the OrderLookupDroplet

Parameters:

pOrderLookupDroplet - the OrderLookupDroplet

getOrder

@Endpoint(id="/orders/{orderId}#GET",
          isSingular=true,
          filterId="orders.id-Default")
public RepresentationModel getOrder(java.lang.String pOrderId)
                                                                                                                                      throws RestException,
                                                                                                                                             CommerceException

Returns a representation of an Order for given order id.

Parameters:

pOrderId - the order id of the order to retrieve

Returns:

RepresentationModel representing the Order

Throws:

RestException - if a problem occurs retrieving the Order

CommerceException

listOrders

@Endpoint(id="/orders/#GET",
          filterId="orders-Default")
public RepresentationModel listOrders(java.lang.String pUserId,
                                                                                                        java.lang.String pState,
                                                                                                        java.lang.String pOpenStates,
                                                                                                        java.lang.String pClosedStates,
                                                                                                        java.lang.String pSiteIds,
                                                                                                        java.lang.String pOrganizationIds,
                                                                                                        java.lang.String pSiteScope,
                                                                                                        java.lang.String pOffset,
                                                                                                        java.lang.String pLimit,
                                                                                                        java.lang.String pOrderBy)
                                                                                                 throws RestException

Retrieves Orders for the current user.

There are options to filter the orders returned by Order State, Sites and Organizations.

Orders can be sorted using the orderBy param, e.g. propertyName:desc. This resource only supports sorting by one property name. The default direction is ascending, like all the framework's paged collections.

The orders will be paged based on the offset & limit params. If not set the paging settings will default to 0 and 30 (or the orderLookup's defaultNumOrders setting).

Null is valid for all options. If all options are null an unsorted, paged set of orders for the current user will be returned (from 0 - defaultNumOrders).

Note that the getForUpdate param is not supported for this paged collection. The order results are always paged on retrieval therefore the output can not be used for a subsequent PATCH merge update as any non paged items will not be part of the output and so would be deleted.

Parameters:

pUserId - The user Id on which to narrow the search by.

pState - Order State to narrow result set returned. Can be one of the named order states OrderStates or one of 2 virtual states 'open' or 'closed'.

pOpenStates - comma separated list of open Order States. This is ignored if pState is not 'open'. If null and pState is 'open' pre-configured list of open states is used.

pClosedStates - comma separated list of closed Order States. This is ignored if pState is not 'closed'. If null and pState is 'closed' pre-configured list of closed states is used.

pSiteIds - comma separated list of Site ids to narrow result set returned.

pOrganizationIds - comma separated list of Organization ids to narrow result set returned.

pSiteScope - the site scope to narrow result set returned. Can be 'all', 'current' or a shareable type ID such as "atg.ShoppingCart". This is ignored if pSiteIds is specified.

pOffset - the page start index

pLimit - the page size

pOrderBy - the Order repository item property to sort results by, direction defaults to ascending unless ':desc' is specified.

Returns:

model of all orders for current user

Throws:

RestException

getCommerceItems

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

Returns the Commerce Items sub resource.

Parameters:

pOrderId - the parent Order Id

Returns:

the Commerce Item sub resource

Throws:

RestException - if a problem occurs obtaining the sub resource

CommerceException - if fails to load order or fails to check if the order exists.

getPaymentGroups

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

Returns the PaymentGroup subresource.

Parameters:

pOrderId - the parent Order Id

Returns:

the Payment Group subresource

Throws:

RestException - if a problem occurs obtaining the subresource

CommerceException - if fails to load order or fails to check if the order exists.

getShippingGroups

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

Returns the ShippingGroup subresource.

Parameters:

pOrderId - the parent Order Id

Returns:

the Shipping Group sub resource

Throws:

RestException - if a problem occurs obtaining the subresource

CommerceException - if fails to load order or fails to check if the order exists.

getShippingGroupCommerceItemRelationships

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

Returns the ShippingGroupCommerceItemRelationship sub resource.

Parameters:

pOrderId - the parent Order Id

Returns:

the shippinggroup commerce item relationship sub resource

Throws:

RestException - if a problem occurs obtaining the sub resource

CommerceException - if fails to load order or fails to check if the order exists.

getPaymentGroupCommerceItemRelationships

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

Returns the PaymentGroupCommerceItemRelationship sub resource.

Parameters:

pOrderId - the parent Order Id

Returns:

the paymentgroup commerce item relationship sub resource

Throws:

RestException - if any problem occurs obtaining the sub resource

CommerceException - if fails to load order or fails to check if the order exists.

getPaymentGroupOrderRelationships

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

Returns the PaymentGroupOrderRelationship sub resource.

Parameters:

pOrderId - id of the order containing the paymentGroup Order relationships

Returns:

the paymentGroupOrderRelationship sub resource

Throws:

RestException - if any problem occurs obtaining the sub resource

CommerceException - if fails to load order or fails to check if the order exists.

getPaymentGroupShippingGroupRelationships

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

Returns the PaymentGroupShippingGroupRelationship sub resource.

Parameters:

pOrderId - id of the order containing the paymentGroup ShippingGroup relationships

Returns:

the paymentGroupShippingGroupRelationship sub resource

Throws:

RestException - if any problem occurs obtaining the sub resource

CommerceException - if fails to load order or fails to check if the order exists.

addToRequestCache

protected void addToRequestCache(java.lang.String pOrderId)
                          throws RestException,
                                 CommerceException

Request cache the Order for use by sub resources.

Parameters:

pOrderId - the parent Order Id

Throws:

RestException - if there is a problem obtaining the Order

CommerceException - if fails to load order or fails to check if the order exists.

retrieveOrder

protected Order retrieveOrder(java.lang.String pOrderId)
                       throws RestException,
                              CommerceException

Retrieve the Order for the given Order Id.

Parameters:

pOrderId - the Order Id to retrieve

Returns:

an Order for given Order Id

Throws:

RestException - if there is a problem retrieving the Order

CommerceException - if fails to load order or fails to check if the order exists.