atg.commerce.order.restresources

Class AbstractOrderRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractOrderRestResource

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:

CartRestResource, OrderRestResource

public abstract class AbstractOrderRestResource
extends GenericService

This class provides the Order sub resources allowing them to be made available to both Order and Cart resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COLON
protected java.lang.String	mEmbeddedAppliedPromotionsRelationshipName
protected java.util.Properties	mEmbeddedResources
protected java.lang.String	mGWPChoicesRelationshipName
protected GWPManager	mGwpManager
protected java.lang.String	mOrderGWPInfoRelationshipName
protected OrderManager	mOrderManager
protected javax.transaction.TransactionManager	mTransactionManager
static java.lang.String	ORDER_ID
static java.lang.String	PIPELINE_RESULT
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
AbstractOrderRestResource()

Method Summary

Modifier and Type	Method and Description
void	addEmbeddedResource(RepresentationModel.Builder pBuilder, java.lang.String pEmbeddedResourceId, java.lang.String pResourceId, boolean pSubResource, boolean pSingular) Add an embedded resource to the representation model.
void	addEmbeddedResources(RepresentationModel.Builder pBuilder) Adds embedded resources to the representation model, as required by the order.
void	addEmbeddedResources(RepresentationModel.Builder pBuilder, boolean pSubResource, boolean pSingular) Adds embedded resources to the representation model, as required by the order.
protected void	addGiftWithPurchaseChoicesLinks(RepresentationModel.Builder pBuilder, java.util.Collection<GiftWithPurchaseSelection> pOrderGifts) This method iterates the collection of GiftWithPurchaseSelection beans, and generates extra links to appear on the RepresentationModel.Builder.
protected void	checkPipelineResult() Checks PipelineResult for errors if any.
protected void	checkPipelineResult(PipelineResult pPipelineResult) Checks a pipeline result for errors.
protected RepresentationModel.Builder	createRepresentationModelBuilder(Order pOrder) Create a RepresentationModel.Builder with the order acting as the state.
java.lang.String	getEmbeddedAppliedPromotionsRelationshipName() Get the relationship name used for the embedded applied promotions.
java.util.Properties	getEmbeddedResources() Gets the embedded resources
java.lang.String	getGWPChoicesRelationshipName() Return the relationship name used for the gift with purchase choices links.
GWPManager	getGwpManager() Returns property GwpManager
java.lang.String	getOrderGWPInfoRelationshipName() Return the relationship name used for the order level gift with purchase information.
OrderManager	getOrderManager() Returns property OrderManager
protected RepresentationModel.Builder	getRepresentationModelBuilder(Order pOrder) Gets the RepresentationModel.Builder with the given order acting as the state.
javax.transaction.TransactionManager	getTransactionManager() Returns property TransactionManager
void	setEmbeddedAppliedPromotionsRelationshipName(java.lang.String pEmbeddedAppliedPromotionsRelationshipName) Configure the relationship name used for the embedded applied promotions.
void	setEmbeddedResources(java.util.Properties pEmbeddedResources) Sets the EmbddedResources property.
void	setGWPChoicesRelationshipName(java.lang.String pGWPChoicesRelationshipName) Configure the relationship name used for the gift with purchase choices links The configured name is used by the filter schema to display the property in the payload.
void	setGwpManager(GWPManager pGwpManager) Sets property GWPManager
void	setOrderGWPInfoRelationshipName(java.lang.String pOrderGWPInfoRelationshipName) Configure the relationship name used for the order level gift with purchase information The configured name is used by the filter schema to display the property in the payload.
void	setOrderManager(OrderManager pOrderManager) Sets property OrderManager
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager) Sets property TransactionManager

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

ORDER_ID

public static final java.lang.String ORDER_ID

See Also:

Constant Field Values

PIPELINE_RESULT

public static final java.lang.String PIPELINE_RESULT

See Also:

Constant Field Values

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

COLON

public static final java.lang.String COLON

See Also:

Constant Field Values

sResourceBundle

public static java.util.ResourceBundle sResourceBundle

Resource Bundle

mTransactionManager

protected javax.transaction.TransactionManager mTransactionManager

mOrderManager

protected OrderManager mOrderManager

mEmbeddedResources

protected java.util.Properties mEmbeddedResources

mEmbeddedAppliedPromotionsRelationshipName

protected java.lang.String mEmbeddedAppliedPromotionsRelationshipName

mOrderGWPInfoRelationshipName

protected java.lang.String mOrderGWPInfoRelationshipName

mGWPChoicesRelationshipName

protected java.lang.String mGWPChoicesRelationshipName

mGwpManager

protected GWPManager mGwpManager

Constructor Detail

AbstractOrderRestResource

public AbstractOrderRestResource()

Method Detail

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Sets property TransactionManager

Parameters:

pTransactionManager - a TransactionManager value

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Returns property TransactionManager

Returns:

a TransactionManager value.

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

Sets property OrderManager

getOrderManager

public OrderManager getOrderManager()

Returns property OrderManager

Returns:

the OrderManager value.

getEmbeddedResources

public java.util.Properties getEmbeddedResources()

Gets the embedded resources

Returns:

the EmbeddedResources value.

setEmbeddedResources

public void setEmbeddedResources(java.util.Properties pEmbeddedResources)

Sets the EmbddedResources property.

Parameters:

pEmbeddedResources - - the EmbeddedResources value.

setEmbeddedAppliedPromotionsRelationshipName

public void setEmbeddedAppliedPromotionsRelationshipName(java.lang.String pEmbeddedAppliedPromotionsRelationshipName)

Configure the relationship name used for the embedded applied promotions.

Parameters:

pEmbeddedAppliedPromotionsRelationshipName - the name of the applied promotions relationship to the embedded resource.

getEmbeddedAppliedPromotionsRelationshipName

public java.lang.String getEmbeddedAppliedPromotionsRelationshipName()

Get the relationship name used for the embedded applied promotions.

Returns:

the relationship name for the embedded applied promotions.

setOrderGWPInfoRelationshipName

public void setOrderGWPInfoRelationshipName(java.lang.String pOrderGWPInfoRelationshipName)

Configure the relationship name used for the order level gift with purchase information The configured name is used by the filter schema to display the property in the payload.

Parameters:

pOrderGWPInfoRelationshipName - the relationship name of the order gwp info property

getOrderGWPInfoRelationshipName

public java.lang.String getOrderGWPInfoRelationshipName()

Return the relationship name used for the order level gift with purchase information. Defaults to 'giftWithPurchaseDiscountInfo'

Returns:

the relationship name of the order level gift with purchase information

setGWPChoicesRelationshipName

public void setGWPChoicesRelationshipName(java.lang.String pGWPChoicesRelationshipName)

Configure the relationship name used for the gift with purchase choices links The configured name is used by the filter schema to display the property in the payload.

Parameters:

pGWPChoicesRelationshipName - the relationship name of the gwp choices links property

getGWPChoicesRelationshipName

public java.lang.String getGWPChoicesRelationshipName()

Return the relationship name used for the gift with purchase choices links. Defaults to 'giftWithPurchase_Choices'

Returns:

the relationship name of the gift with purchase choices links

setGwpManager

public void setGwpManager(GWPManager pGwpManager)

Sets property GWPManager

Parameters:

pGwpManager - the GWPManager component property.

getGwpManager

public GWPManager getGwpManager()

Returns property GwpManager

Returns:

the GWPManager component property.

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(Order pOrder)
                                                             throws CommerceException

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

See createRepresentationModelBuilder(Order) for further details as to what is generated as part of the builder.

Parameters:

pOrder - the order from which the RepresentationModel.Builder will be created

Returns:

RepresentationModel.Builder containing the state

Throws:

CommerceException - if a problem occurred whilst generating the builder

createRepresentationModelBuilder

protected RepresentationModel.Builder createRepresentationModelBuilder(Order pOrder)
                                                                throws CommerceException

Create a RepresentationModel.Builder with the order acting as the state.

Pricing messages and gift with purchase information are included as additional state.

Applied promotions are also embedded.

Parameters:

pOrder - the order from which the RepresentationModel.Builder will be created

Returns:

a newly created RepresentationModel.Builder

Throws:

CommerceException - if a problem occurred whilst creating the builder

addEmbeddedResources

public void addEmbeddedResources(RepresentationModel.Builder pBuilder)
                          throws RestException

Adds embedded resources to the representation model, as required by the order.

Calls addEmbeddedResources(RepresentationModel.Builder, boolean, boolean) with values of true for subresource and false for singular.

Parameters:

pBuilder - - the RepresentationModel Builder on which to add the embedded resources.

Throws:

RestException - if a problem occurs embedding a resource.

addEmbeddedResources

public void addEmbeddedResources(RepresentationModel.Builder pBuilder,
                                 boolean pSubResource,
                                 boolean pSingular)
                          throws RestException

Adds embedded resources to the representation model, as required by the order.

Parameters:

pBuilder - - the RepresentationModel Builder on which to add the embedded resources.

pSubResource - - indicates if the resource is a sub resource or not.

pSingular - - indicates if the resource is a singular resource.

Throws:

RestException - if a problem occurs embedding a resource.

addEmbeddedResource

public void addEmbeddedResource(RepresentationModel.Builder pBuilder,
                                java.lang.String pEmbeddedResourceId,
                                java.lang.String pResourceId,
                                boolean pSubResource,
                                boolean pSingular)
                         throws RestException

Add an embedded resource to the representation model. The subresource can be included even if it is not a subresource of current context. E.g. If the current context uri is /cart/repriceCart, as CommerceItem is a subresource of order and it is not a subresource of repriceCart, setting pSubresource to false will include commerceItems in current order RepresentationModel.Set pSingular to true if subresource is a collection.

Parameters:

pBuilder - - the RepresentationModel Builder on which to add the embedded resources.

pEmbeddedResourceId - - the embedded resource Id used to identify the resource in the RepresentationModel.

pResourceId - - the global resource Id.

pSubResource - - true if uri being built is subresource of current context.

pSingular - - true if the singular of the given resource should be used.

Throws:

RestException - if a problem occurs embedding a resource.

addGiftWithPurchaseChoicesLinks

protected void addGiftWithPurchaseChoicesLinks(RepresentationModel.Builder pBuilder,
                                               java.util.Collection<GiftWithPurchaseSelection> pOrderGifts)

This method iterates the collection of GiftWithPurchaseSelection beans, and generates extra links to appear on the RepresentationModel.Builder. These links will use the relationship name 'gwp_choices', and have link parameters 'gwp_identifier' added to uniquely identify which gift the link belongs to.

Parameters:

pBuilder - RepresentationModel.Builder used to create the order representation

pOrderGifts - Collection of GiftWithPurchaseSelection beans to be inspected

checkPipelineResult

protected void checkPipelineResult()
                            throws RestException

Checks PipelineResult for errors if any.

Throws:

RestException - if a pipeline processing issue occurs.

checkPipelineResult

protected void checkPipelineResult(PipelineResult pPipelineResult)
                            throws RestException

Checks a pipeline result for errors. If all the errors are string messages or exceptions with a non-null error code, the RestException thrown here will have a BAD_REQUEST status code. If any of the pipeline errors is an exception with no error code or any other type of Object, the RestException will have an INTERNAL_SERVER_ERROR status code.

Parameters:

pPipelineResult - the messages and exceptions returned from execution of a pipeline chain

Throws:

RestException - if pPipelineResult contains any errors.