atg.commerce.order.restresources

Class PaymentGroupRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractCommerceIdentifierRestSubresource

atg.commerce.order.restresources.PaymentGroupRestSubresource

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:

CartPaymentGroupRestSubresource

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

Class that defines the RESTful endpoints for Payment Groups

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
protected void	checkPaymentGroupIsAvailableForOrder(Order pOrder, java.lang.String pPaymentGroupId) Check whether the payment group is available in the PaymentGroup container.
OrderManager	getOrderManager() Returns property OrderManager
protected PaymentGroup	getPaymentGroup(Order pOrder, java.lang.String pPaymentGroupId) Retrieves a specific payment group from an order.
RepresentationModel	getPaymentGroup(java.lang.String pPaymentGroupId) Endpoint that provides the Payment Groups for an Order based on its ID
PaymentGroupManager	getPaymentGroupManager() Returns property PaymentGroupManager
RepresentationModel	getPaymentGroups() Endpoint that provides the Payment Groups for an Order.
void	setOrderManager(OrderManager pOrderManager) Sets property OrderManager
void	setPaymentGroupManager(PaymentGroupManager pPaymentGroupManager) Sets property PaymentGroupManager

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_PAYMENT_GROUP_NOT_FOUND

public static final java.lang.String ERR_PAYMENT_GROUP_NOT_FOUND

See Also:

Constant Field Values

Constructor Detail

PaymentGroupRestSubresource

public PaymentGroupRestSubresource()

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

setPaymentGroupManager

public void setPaymentGroupManager(PaymentGroupManager pPaymentGroupManager)

Sets property PaymentGroupManager

Parameters:

pPaymentGroupManager - - the PaymentGroupManager object to be set

getPaymentGroupManager

public PaymentGroupManager getPaymentGroupManager()

Returns property PaymentGroupManager

Returns:

PaymentGroupManager component

getPaymentGroup

@Endpoint(id="/paymentGroups/{paymentGroupId}#GET",
          isSingular=true,
          filterId="paymentGroups.id-Default")
public RepresentationModel getPaymentGroup(java.lang.String pPaymentGroupId)
                                                                                                                                                                  throws RestException,
                                                                                                                                                                         CommerceException

Endpoint that provides the Payment Groups for an Order based on its ID

Returns:

model representation of the List of Payment Groups

Throws:

RestException - if any error occurs while retrieving the payment group

CommerceException - if invalid payment group id is supplied

getPaymentGroups

@Endpoint(id="/paymentGroups#GET",
          filterId="paymentGroups-Default")
public RepresentationModel getPaymentGroups()
                                                                                                                    throws RestException

Endpoint that provides the Payment Groups for an Order.

Returns:

model representation of the List of Payment Groups

Throws:

RestException - if something went wrong whilst getting the payment groups

getPaymentGroup

protected PaymentGroup getPaymentGroup(Order pOrder,
                                       java.lang.String pPaymentGroupId)
                                throws RestException,
                                       CommerceException

Retrieves a specific payment group from an order.

Parameters:

pOrder - The parent order

pPaymentGroupId - The ID of the requested payment group

Returns:

PaymentGroup The requested payment group

Throws:

RestException - if there is a problem obtaining the payment group

CommerceException - if the PaymentGroup with the corresponding id is not in the container

checkPaymentGroupIsAvailableForOrder

protected void checkPaymentGroupIsAvailableForOrder(Order pOrder,
                                                    java.lang.String pPaymentGroupId)
                                             throws RestException

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

Parameters:

pOrder - the order containing the payment groups

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

Throws:

RestException - with NOT_FOUND status if the payment group is invalid