atg.commerce.order.restresources

Class PaymentGroupShippingGroupRelationshipRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractCommerceIdentifierRestSubresource

atg.commerce.order.restresources.PaymentGroupShippingGroupRelationshipRestSubresource

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.PaymentGroupShippingGroupRelationshipRestSubresource")
public class PaymentGroupShippingGroupRelationshipRestSubresource
extends AbstractCommerceIdentifierRestSubresource

This resource class provides the endpoints for PaymentGroup ShippingGroup relationships in the order.PaymentGroupShippingGroup relationship represents how each group of items to be shipped to the customer will be paid for. The two valid relationship types are ShippingAmount and ShippingAmountRemaining.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
OrderManager	getOrderManager() Gets the order manager component which provides the methods to access payment group manager and commerce item manager etc
protected PaymentGroupShippingGroupRelationship	getPaymentGroupShippingGroupRelationship(Order pOrder, java.lang.String pRelationshipId) Retrieves the specific payment group shipping group relationship for the order.
RepresentationModel	getPaymentGroupShippingGroupRelationship(java.lang.String pRelationshipId, java.lang.String pOrderId) Returns the PaymentGroupShippingGroup relationship for the given relationshipId in the order.
RepresentationModel	getPaymentGroupShippingGroupRelationships() Collection endpoint returning the paymentGroup shippingGroup relationships for the given parent order.
protected java.util.List	getPaymentGroupShippingGroupRelationships(Order pOrder) For the given order this method returns list of payment group shipping group relationships.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState, java.lang.String pOrderId) Gets the RepresentationModel.Builder with the given object acting as the state.
void	setOrderManager(OrderManager pOrderManager) Sets the order manager component which provides the methods to access payment group manager and commerce item manager etc.

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

NO_PAYMENT_GROUP_SHIPPING_GROUP_REL_FOUND

public static final java.lang.String NO_PAYMENT_GROUP_SHIPPING_GROUP_REL_FOUND

See Also:

Constant Field Values

Constructor Detail

PaymentGroupShippingGroupRelationshipRestSubresource

public PaymentGroupShippingGroupRelationshipRestSubresource()

Method Detail

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

Sets the order manager component which provides the methods to access payment group manager and commerce item manager etc.

Parameters:

pOrderManager - the order manager component which provides the methods to access payment group manager and commerce item manager etc

getOrderManager

public OrderManager getOrderManager()

Gets the order manager component which provides the methods to access payment group manager and commerce item manager etc

Returns:

the order manager component which provides the methods to access payment group manager and commerce item manager etc

getPaymentGroupShippingGroupRelationship

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

Returns the PaymentGroupShippingGroup relationship for the given relationshipId in the order.

Also embeds the paymentGroup and shippingGroup summaries in the PaymentGroupShippingGroup relationship.

Parameters:

pRelationshipId - Id of the paymentGroupShippingGroupRelationship to be retrieved

pOrderId - Id of the order for which shippingGroupCommerceItemRelationship is to be retrieved.

Returns:

the RepresentationModel containing paymentGroupShippingGroupRelationship

Throws:

RestException - if an internal error occurred whilst getting the payment group shipping group relationship

CommerceException - if an internal error occurred whilst getting the payment group shipping group relationship

getPaymentGroupShippingGroupRelationships

@Endpoint(id="/paymentGroupShippingGroupRelationships#GET",
          isSingular=false,
          filterId="paymentGroupShippingGroupRelationships-Default")
public RepresentationModel getPaymentGroupShippingGroupRelationships()
                                                                                                                                                                                                                           throws RestException,
                                                                                                                                                                                                                                  CommerceException

Collection endpoint returning the paymentGroup shippingGroup relationships for the given parent order.

Returns:

the RepresentationModel containing list of paymentGroupShippingGroupRelationships

Throws:

RestException - if an internal error occurred whilst getting the payment group shipping group relationships

CommerceException - if an internal error occurred whilst getting the payment group shipping group relationships

getPaymentGroupShippingGroupRelationship

protected PaymentGroupShippingGroupRelationship getPaymentGroupShippingGroupRelationship(Order pOrder,
                                                                                         java.lang.String pRelationshipId)
                                                                                  throws RestException,
                                                                                         CommerceException

Retrieves the specific payment group shipping group relationship for the order.

Parameters:

pOrder - the order from which to retrieve the relationship

pRelationshipId - the relationship to retrieve

Returns:

the required payment group shipping group relationship

Throws:

RestException - if pRelationshipId is not found in the order

CommerceException - if an internal error occurred whilst getting the payment group shipping group relationships

getPaymentGroupShippingGroupRelationships

protected java.util.List getPaymentGroupShippingGroupRelationships(Order pOrder)
                                                            throws CommerceException

For the given order this method returns list of payment group shipping group relationships. This is invoked from endpoint methods both singular and collection to get the order relationships

Parameters:

pOrder - the order containing the paymentGroupShippingGroup relationships

Returns:

list of payment group shipping group relationships for the given order

Throws:

CommerceException - if any internal error occurs

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.Object pState,
                                                                    java.lang.String pOrderId)
                                                             throws RestException

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

Also embeds the paymentGroup and shippingGroup summaries.

Parameters:

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

pOrderId - the id of the order , will be null for a cart.

Returns:

RepresentationModel.Builder containing the state and the embedded paymentGroup and shippingGroup summaries.

Throws:

RestException