atg.commerce.order.restresources

Class CartPaymentGroupRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractCommerceIdentifierRestSubresource

atg.commerce.order.restresources.PaymentGroupRestSubresource

atg.commerce.order.restresources.CartPaymentGroupRestSubresource

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, UpdateableRestResource, java.util.EventListener

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

Subresource class that provides the payment group related endpoints for the cart parent resource. The endpoints in this resource class can only be applied on the current order payment groups.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AMOUNT
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COMMERCE_ITEM_ID
static java.lang.String	PAYMENT_GROUP_ID
static java.lang.String	RELATIONSHIPS
static java.lang.String	SHIPPING_GROUP_ID

Fields inherited from class atg.commerce.order.restresources.PaymentGroupRestSubresource

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

Method Summary

Modifier and Type	Method and Description
RepresentationModel	addPaymentGroup(org.json.JSONObject pInputJson) Add a new Payment Group to the current order.
java.lang.Object	deletePaymentGroup(java.lang.String pPaymentGroupId) Removes the paymentGroup from the current order based on the paymentGroupId.
CommerceProfileTools	getCommerceProfileTools() returns the property CommerceProfileTools
ShippingGroupManager	getShippingGroupManager() Returns the ShippingGroupManager
RepresentationModel	relateToItems(org.json.JSONObject pInputJson) Creates/modifies relationships between commerce items and payment groups, on the current order.
RepresentationModel	relateToOrder(org.json.JSONObject pInputJson) Creates/modifies relationships between payment groups and the current order.
RepresentationModel	relateToShippingGroups(org.json.JSONObject pInputJson) Creates/modifies relationships between payment groups and shipping groups, on the current order.
void	setCommerceProfileTools(CommerceProfileTools pCommerceProfileTools) Set property CommerceProfileTools
void	setShippingGroupManager(ShippingGroupManager pShippingGroupManager) Sets the ShippingGroupManager
java.net.URI	update(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo) Updates the PaymentGroups in the Cart.
protected void	updateOrder(Order pOrder) Updates the order
RepresentationModel	updatePaymentGroup(java.lang.String pPaymentGroupId, org.json.JSONObject pInputJson) Updates a payment group associated with the current order
RepresentationModel	updatePaymentGroups(org.json.JSONObject pInputJson) This endpoint removes, updates or creates the payment groups as part of the collection update.

Methods inherited from class atg.commerce.order.restresources.PaymentGroupRestSubresource

checkPaymentGroupIsAvailableForOrder, getOrderManager, getPaymentGroup, getPaymentGroup, getPaymentGroupManager, getPaymentGroups, setOrderManager, setPaymentGroupManager

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

Methods inherited from interface atg.service.jaxrs.restresources.UpdateableRestResource

updateEmbeddedResources

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

SHIPPING_GROUP_ID

public static final java.lang.String SHIPPING_GROUP_ID

See Also:

Constant Field Values

PAYMENT_GROUP_ID

public static final java.lang.String PAYMENT_GROUP_ID

See Also:

Constant Field Values

COMMERCE_ITEM_ID

public static final java.lang.String COMMERCE_ITEM_ID

See Also:

Constant Field Values

RELATIONSHIPS

public static final java.lang.String RELATIONSHIPS

See Also:

Constant Field Values

AMOUNT

public static final java.lang.String AMOUNT

See Also:

Constant Field Values

Constructor Detail

CartPaymentGroupRestSubresource

public CartPaymentGroupRestSubresource()

Method Detail

setCommerceProfileTools

public void setCommerceProfileTools(CommerceProfileTools pCommerceProfileTools)

Set property CommerceProfileTools

Parameters:

pCommerceProfileTools - the value to set for property CommerceProfileTools

getCommerceProfileTools

public CommerceProfileTools getCommerceProfileTools()

returns the property CommerceProfileTools

Returns:

returns property CommerceProfileTools

getShippingGroupManager

public ShippingGroupManager getShippingGroupManager()

Returns the ShippingGroupManager

Returns:

the ShippingGroupManager

setShippingGroupManager

public void setShippingGroupManager(ShippingGroupManager pShippingGroupManager)

Sets the ShippingGroupManager

Parameters:

pShippingGroupManager - new ShippingGroupManager

addPaymentGroup

@Endpoint(id="/paymentGroups#POST",
          validatorId="paymentGroups.id-FullWithCart",
          updateTarget=true)
public RepresentationModel addPaymentGroup(org.json.JSONObject pInputJson)
                                                                                                                                                            throws RestException,
                                                                                                                                                                   CommerceException

Add a new Payment Group to the current order.

Parameters:

pInputJson - A JSONObject that contains the PaymentGroupType (type - eg cash, creditCard) and subsequent details that are specific for that particular type

Returns:

RepresentationModel of the newly added PaymentGroup

Throws:

RestException - if an internal error occurs while adding a new PaymentGroup

CommerceException - if an internal error occurs while adding a new PaymentGroup

deletePaymentGroup

@Endpoint(id="/paymentGroups/{paymentGroupId}#DELETE",
          isSingular=true,
          filterId="paymentGroups-Delete")
public java.lang.Object deletePaymentGroup(java.lang.String pPaymentGroupId)
                                                                                                                                                                 throws RestException,
                                                                                                                                                                        CommerceException

Removes the paymentGroup from the current order based on the paymentGroupId. As the sub-resource delete can affect the top-level resource details, e.g. order level price info, we deviate from the normal NO_CONTENT response. We return @see atg.service.jaxrs.RepresentationModel with the top-level cart (summary) embedded in the response to reflect any changes. The response state will return the resource collection affected by the delete. Most customers will not need this so ootb only filter/display the cart summary.

Parameters:

pPaymentGroupId - Id of the paymentGroup to be removed from the current order

Returns:

a RepresentationModel if the payment group is successfully removed from the order

Throws:

RestException - if any internal error occurs while removing the paymentGroup

CommerceException - if any error removing the paymentGroup from the current order

updatePaymentGroup

@PATCH
 @Endpoint(id="/paymentGroups/{paymentGroupId}#PATCH",
          isSingular=true,
          validatorId="paymentGroups.id-Full",
          filterId="paymentGroups.id-Full",
          updateTarget=true)
public RepresentationModel updatePaymentGroup(java.lang.String pPaymentGroupId,
                                                                                                                                                                                                                                                               org.json.JSONObject pInputJson)
                                                                                                                                                                                                                                                        throws RestException,
                                                                                                                                                                                                                                                               CommerceException

Updates a payment group associated with the current order

Parameters:

pPaymentGroupId - the id of the payment group to update

pInputJson - representation of payment group updates to apply

Returns:

the representation model containing the updated payment group

Throws:

CommerceException - if a problem occurred whilst updating the payment group

RestException - if an internal error occurred whilst updating the payment group

updatePaymentGroups

@PATCH
 @Endpoint(id="/paymentGroups#PATCH",
          validatorId="paymentGroups-Full",
          filterId="paymentGroups-DefaultWithCart",
          updateTarget=true)
public RepresentationModel updatePaymentGroups(org.json.JSONObject pInputJson)
                                                                                                                                                                                                                  throws RestException,
                                                                                                                                                                                                                         CommerceException

This endpoint removes, updates or creates the payment groups as part of the collection update. Items in the collection containing the id property along with the some other properties are considered for update, items containing all the required properties except the id are considered for create and all other the items are removed from the collection.

Parameters:

pInputJson - representation of payment groups

Returns:

the representation model containing the updated list of payment groups

Throws:

RestException - if an internal error occurred whilst updating the payment groups in the order

CommerceException - if an internal error occurred whilst updating the payment groups in the order

relateToShippingGroups

@Endpoint(id="paymentGroups/relateToShippingGroups#POST",
          validatorId="paymentGroups.relateToShippingGroups",
          filterId="paymentGroups-DefaultWithCart",
          updateTarget=true)
public RepresentationModel relateToShippingGroups(org.json.JSONObject pInputJson)
                                                                                                                                                                                                                                                    throws RestException,
                                                                                                                                                                                                                                                           CommerceException

Creates/modifies relationships between payment groups and shipping groups, on the current order. If a relationship already exists, this method will update that relationship, setting it's amount to the amount value provided in the input data. An amount value of -1.0 indicates that the relationship should be a amount remaining relationship. Specifically, this means that any un-assigned quantity of the commerce item should be added to the specified shipping group. An amount value of 0.0 has the effect of removing an existing relationship.

 
 {
  "relationships" : [
   {
    "paymentGroupId" : "pg1234",
    "shippingGroupId" : "sg1234",
    "amount" : 21.55
   },
   {
    "paymentGroupId" : "pg3337",
    "shippingGroupId" : "sg6658",
    "amount" : 1.99
   },
   ...
  ]
 }
 
 

Parameters:

pInputJson - A JSONObject that contains the relationships to setup/modify.

Returns:

RepresentationalModel of the Order's PaymentGroups.

Throws:

RestException - if an error with the input data, e.g. missing data

CommerceException - if any internal error occurs while creating/updating relationships

relateToOrder

@Endpoint(id="paymentGroups/relateToOrder#POST",
          validatorId="paymentGroups.relateToOrder",
          filterId="paymentGroups-DefaultWithCart",
          updateTarget=true)
public RepresentationModel relateToOrder(org.json.JSONObject pInputJson)
                                                                                                                                                                                                                         throws RestException,
                                                                                                                                                                                                                                CommerceException

Creates/modifies relationships between payment groups and the current order. If a relationship already exists, this method will update that relationship, setting it's amount to the amount value provided in the input data. An amount value of -1.0 indicates that the relationship should be a amount remaining relationship. Specifically, this means that any un-assigned quantity of the commerce item should be added to the specified shipping group. An amount value of 0.0 has the effect of removing an existing relationship.

 
 {
  "relationships" : [
   {
    "paymentGroupId" : "pg1234",
    "amount" : 21.55
   },
   {
    "paymentGroupId" : "pg3337",
    "amount" : -1.0
   },
   ...
  ]
 }
 
 

Parameters:

pInputJson - A JSONObject that contains the relationships to setup/modify.

Returns:

RepresentationalModel of the Order's PaymentGroups.

Throws:

RestException - if an error with the input data, e.g. missing data

CommerceException - if any internal error occurs while creating/updating relationships

relateToItems

@Endpoint(id="paymentGroups/relateToItems#POST",
          validatorId="paymentGroups.relateToItems",
          filterId="paymentGroups-DefaultWithCart",
          updateTarget=true)
public RepresentationModel relateToItems(org.json.JSONObject pInputJson)
                                                                                                                                                                                                                         throws RestException,
                                                                                                                                                                                                                                CommerceException

Creates/modifies relationships between commerce items and payment groups, on the current order. If a relationship already exists, this method will update that relationship, setting it's quantity to the quantity value provided in the input data. A quantity value of -1.0 indicates that the relationship should be a quantity remaining relationship. Specifically, this means that any un-assigned quantity of the commerce item should be added to the specified shipping group. A quantity value of 0.0 has the effect of removing an existing relationship.

 
 {
  "relationships" : [
   {
    "commerceItemId" : "ci6544",
    "paymentGroupId" : "pg1234",
    "amount" : 2.50
   },
   {
    "commerceItemId" : "ci4444",
    "paymentGroupId" : "pg3337",
    "amount" : 0.0
   },
   ...
  ]
 }
 
 

Parameters:

pInputJson - A JSONObject that contains the relationships to setup/modify.

Returns:

RepresentationalModel of the Order's PaymentGroups.

Throws:

RestException - if an error with the input data, e.g. missing data

CommerceException - if any internal error occurs while creating/updating relationships

update

public java.net.URI update(atg.service.jaxrs.ResourceUpdateInfo pUpdateInfo)
                    throws RestException

Updates the PaymentGroups in the Cart.

Specified by:

update in interface UpdateableRestResource

Parameters:

pUpdateInfo - - update object containing request input and any existing repository (payment groups) data to be updated

Returns:

URI - self link to any newly created item, or null if none created

Throws:

RestException - - if an issue occurs performing the update

updateOrder

protected void updateOrder(Order pOrder)
                    throws CommerceException

Updates the order

Parameters:

pOrder - the current order to be updated

Throws:

CommerceException - if an error occurs while updating the Order