atg.commerce.order.restresources

Class AbstractCommerceIdentifierRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractCommerceIdentifierRestSubresource

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:

CommerceItemRestSubresource, PaymentGroupCommerceItemRelationshipRestSubresource, PaymentGroupOrderRelationshipRestSubresource, PaymentGroupRestSubresource, PaymentGroupShippingGroupRelationshipRestSubresource, ShippingGroupCommerceItemRelationshipRestSubresource, ShippingGroupRestSubresource

public abstract class AbstractCommerceIdentifierRestSubresource
extends GenericService

This class provides shared logic for order sub-resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static int	DEFAULT_PAGE_SIZE
protected java.lang.String	mEmbeddedCommerceItemRelationshipName
protected java.lang.String	mEmbeddedPaymentGroupRelationshipName
protected java.lang.String	mEmbeddedShippingGroupRelationshipName
static java.lang.String	RESOURCE_NAME
static java.util.ResourceBundle	sResourceBundle Resource Bundle

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

Method Summary

Modifier and Type	Method and Description
protected void	addCreatedItemUri(RepresentationModel.Builder pBuilder, java.lang.String pResourceId, CommerceIdentifier pCreatedItem) Adds a created uri to the given RepresentationModel.Builder, based on the given resource id and the CommerceIdentifier.
protected java.lang.String[]	buildMemberUris(java.util.Collection<CommerceIdentifier> pCommerceIdentifiers, <any> pQueryParams) Build the members URIs for the given list of items of type CommerceIdentifier.
protected java.lang.String	getCartUri() Build a resource URI for the Cart.
protected java.net.URI	getCreatedItemUri(atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo) Build a URI to the newly added/created item if present.
int	getDefaultLimit() Returns the default limit to use for paging if no 'limit' param set
java.lang.String	getEmbeddedCartRelationshipName() Get the relationship name used when embedding the cart resource.
java.lang.String	getEmbeddedCommerceItemRelationshipName() Get the relationship name used for the embedded commerce item resource.
java.lang.String	getEmbeddedPaymentGroupRelationshipName() Get the relationship name used for the embedded payment group resource.
java.lang.String	getEmbeddedShippingGroupRelationshipName() Get the relationship name used for the embedded shipping group resource.
Order	getOrder() Retrieve the Order from the request cache.
protected java.util.Optional<Relationship>	getRelationshipCreated(java.util.List<Relationship> pPreRelationships, java.util.List<Relationship> pPostRelationships) Compare the pre and post lists of Relationships, returning the first unmatched Relationship.
protected java.util.List<Relationship>	getRelationships(java.util.List<Relationship> pRelationships) Copy the given list to a new list of Relationships.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.util.Collection<CommerceIdentifier> pMembers) Gets the RepresentationModel.Builder with the given collection of CommerceIdentifiers being used to build member URIs.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
protected RepresentationModel.Builder	getRepresentationModelBuilderWithCart(java.util.Collection<CommerceIdentifier> pMembers) Gets the RepresentationModel.Builder with the given collection of CommerceIdentifiers being used to build member URIs.
protected RepresentationModel.Builder	getRepresentationModelBuilderWithCart(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
protected RepresentationModel.Builder	getRepresentationModelBuilderWithPaging(java.util.Collection<CommerceIdentifier> pMembers) Gets the RepresentationModel.Builder with the given collection of CommerceIdentifiers being used to build member URIs and page the collection.
protected Link	getSelfLink(java.lang.String pItemId) Build a self link for the item resource.
void	setDefaultLimit(int pDefaultLimit) Sets the default limit to use for paging if no 'limit' param set
void	setEmbeddedCartRelationshipName(java.lang.String pEmbeddedCartRelationshipName) Configure the relationship name used for the embedded cart resource.
void	setEmbeddedCommerceItemRelationshipName(java.lang.String pEmbeddedCommerceItemRelationshipName) Configure the relationship name used for the embedded commerce item resource.
void	setEmbeddedPaymentGroupRelationshipName(java.lang.String pEmbeddedPaymentGroupRelationshipName) Configure the relationship name used for the embedded payment group resource.
void	setEmbeddedShippingGroupRelationshipName(java.lang.String pEmbeddedShippingGroupRelationshipName) Configure the relationship name used for the embedded shipping group resource.

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

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

sResourceBundle

public static java.util.ResourceBundle sResourceBundle

Resource Bundle

mEmbeddedCommerceItemRelationshipName

protected java.lang.String mEmbeddedCommerceItemRelationshipName

mEmbeddedPaymentGroupRelationshipName

protected java.lang.String mEmbeddedPaymentGroupRelationshipName

mEmbeddedShippingGroupRelationshipName

protected java.lang.String mEmbeddedShippingGroupRelationshipName

Constructor Detail

AbstractCommerceIdentifierRestSubresource

public AbstractCommerceIdentifierRestSubresource()

Method Detail

setEmbeddedCartRelationshipName

public void setEmbeddedCartRelationshipName(java.lang.String pEmbeddedCartRelationshipName)

Configure the relationship name used for the embedded cart resource. To display the embedded resource the filter configuration also uses this name. If set the filter configuration will need updated to reflect the change.

Parameters:

pEmbeddedCartRelationshipName - the name of the relationship to the embedded resource

getEmbeddedCartRelationshipName

public java.lang.String getEmbeddedCartRelationshipName()

Get the relationship name used when embedding the cart resource.

Returns:

the relationship name of the embedded cart resource

setEmbeddedCommerceItemRelationshipName

public void setEmbeddedCommerceItemRelationshipName(java.lang.String pEmbeddedCommerceItemRelationshipName)

Configure the relationship name used for the embedded commerce item resource.

Parameters:

pEmbeddedCommerceItemRelationshipName - the name of the relationship to the embedded commerce item resource.

getEmbeddedCommerceItemRelationshipName

public java.lang.String getEmbeddedCommerceItemRelationshipName()

Get the relationship name used for the embedded commerce item resource.

Returns:

the relationship name for the embedded commerce item resource.

setEmbeddedPaymentGroupRelationshipName

public void setEmbeddedPaymentGroupRelationshipName(java.lang.String pEmbeddedPaymentGroupRelationshipName)

Configure the relationship name used for the embedded payment group resource.

Parameters:

pEmbeddedPaymentGroupRelationshipName - the name of the relationship to the embedded payment group resource.

getEmbeddedPaymentGroupRelationshipName

public java.lang.String getEmbeddedPaymentGroupRelationshipName()

Get the relationship name used for the embedded payment group resource.

Returns:

the relationship name for the embedded payment group resource.

setEmbeddedShippingGroupRelationshipName

public void setEmbeddedShippingGroupRelationshipName(java.lang.String pEmbeddedShippingGroupRelationshipName)

Configure the relationship name used for the embedded shipping group resource.

Parameters:

pEmbeddedShippingGroupRelationshipName - the name of the relationship to the embedded shipping group resource.

getEmbeddedShippingGroupRelationshipName

public java.lang.String getEmbeddedShippingGroupRelationshipName()

Get the relationship name used for the embedded shipping group resource.

Returns:

the relationship name for the embedded shipping group resource.

getDefaultLimit

public int getDefaultLimit()

Returns the default limit to use for paging if no 'limit' param set

Returns:

the limit

setDefaultLimit

public void setDefaultLimit(int pDefaultLimit)

Sets the default limit to use for paging if no 'limit' param set

Parameters:

pDefaultLimit - the limit to set

getOrder

public Order getOrder()
               throws RestException

Retrieve the Order from the request cache.

Returns:

the Order from the request cache.

Throws:

RestException - if there is a problem obtaining the Order.

getSelfLink

protected Link getSelfLink(java.lang.String pItemId)

Build a self link for the item resource.

Parameters:

pItemId - - Item Id from which to build the self link.

Returns:

Self link for the given item.

getCartUri

protected java.lang.String getCartUri()

Build a resource URI for the Cart.

Returns:

Resource URI for Cart.

getCreatedItemUri

protected java.net.URI getCreatedItemUri(atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo)

Build a URI to the newly added/created item if present.

Parameters:

pResourceUpdateInfo - - ResourceUpdateInfo representing the actions taken.

Returns:

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

addCreatedItemUri

protected void addCreatedItemUri(RepresentationModel.Builder pBuilder,
                                 java.lang.String pResourceId,
                                 CommerceIdentifier pCreatedItem)

Adds a created uri to the given RepresentationModel.Builder, based on the given resource id and the CommerceIdentifier.

Parameters:

pBuilder - the builder to which the created uri will be added

pResourceId - the id of the rest resource that was created

pCreatedItem - the created item whose id will be used in the creation of the uri

buildMemberUris

protected java.lang.String[] buildMemberUris(java.util.Collection<CommerceIdentifier> pCommerceIdentifiers,
                                             <any> pQueryParams)
                                      throws RestException

Build the members URIs for the given list of items of type CommerceIdentifier.

Parameters:

pCommerceIdentifiers - the list of commerce identifier items from which to build the member URIs

pQueryParams - optional map of query param key/value pairs to be added to any built uris, null if none

Returns:

an array of URI's where each element represents a GET URI

Throws:

RestException - if a problem occurred whilst building the member URIs

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.Object pState)

Gets the RepresentationModel.Builder with the given object acting as the state.

Parameters:

pState - the state that will be added to the representation model

Returns:

RepresentationModel.Builder containing the state

getRepresentationModelBuilderWithCart

protected RepresentationModel.Builder getRepresentationModelBuilderWithCart(java.lang.Object pState)
                                                                     throws RestException

Gets the RepresentationModel.Builder with the given object acting as the state.

Also includes the embedded cart.

Parameters:

pState - the state that will be added to the representation model

Returns:

RepresentationModel.Builder containing the state and the embedded cart

Throws:

RestException

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.util.Collection<CommerceIdentifier> pMembers)
                                                             throws RestException

Gets the RepresentationModel.Builder with the given collection of CommerceIdentifiers being used to build member URIs.

Parameters:

pMembers - the members that will be added to the representation model

Returns:

RepresentationModel.Builder containing the member uris

Throws:

RestException - if the member URIs could not be built

getRepresentationModelBuilderWithPaging

protected RepresentationModel.Builder getRepresentationModelBuilderWithPaging(java.util.Collection<CommerceIdentifier> pMembers)
                                                                       throws RestException

Gets the RepresentationModel.Builder with the given collection of CommerceIdentifiers being used to build member URIs and page the collection. Sort is not supported and the current params are passed down to member uri.

Returns:

RepresentationModel.Builder for collection endpoints.

Throws:

RestException

getRepresentationModelBuilderWithCart

protected RepresentationModel.Builder getRepresentationModelBuilderWithCart(java.util.Collection<CommerceIdentifier> pMembers)
                                                                     throws RestException

Gets the RepresentationModel.Builder with the given collection of CommerceIdentifiers being used to build member URIs.

Also includes the embedded cart.

Parameters:

pMembers - the members that will be added to the representation model

Returns:

RepresentationModel.Builder containing the member uris and the embedded cart

Throws:

RestException - if the member URIs could not be built

getRelationshipCreated

protected java.util.Optional<Relationship> getRelationshipCreated(java.util.List<Relationship> pPreRelationships,
                                                                  java.util.List<Relationship> pPostRelationships)

Compare the pre and post lists of Relationships, returning the first unmatched Relationship.

Parameters:

pPreRelationships - the list of relations pre-processing of an operation.

pPostRelationships - the list of relations post-processing of an operation.

Returns:

the first unmatched Relationship, i.e. a Relationship that is in the post list and not in pre list.

getRelationships

protected java.util.List<Relationship> getRelationships(java.util.List<Relationship> pRelationships)

Copy the given list to a new list of Relationships.

Parameters:

pRelationships - list to be copied.

Returns:

a list of relationships