@RestResource(id="atg.commerce.order.restresources.PaymentGroupOrderRelationshipRestSubresource") public class PaymentGroupOrderRelationshipRestSubresource extends AbstractCommerceIdentifierRestSubresource
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
NO_PAYMENT_GROUP_ORDER_REL_FOUND |
DEFAULT_PAGE_SIZE, mEmbeddedCommerceItemRelationshipName, mEmbeddedPaymentGroupRelationshipName, mEmbeddedShippingGroupRelationshipName, RESOURCE_NAME, sResourceBundle
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
PaymentGroupOrderRelationshipRestSubresource() |
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 PaymentGroupOrderRelationship |
getPaymentGroupOrderRelationship(Order pOrder,
java.lang.String pRelationshipId)
Retrieves the specific payment group order relationship.
|
RepresentationModel |
getPaymentGroupOrderRelationship(java.lang.String pRelationshipId,
java.lang.String pOrderId)
Returns the PaymentGroup Order relationship for the given relationshipId in the order.
|
RepresentationModel |
getPaymentGroupOrderRelationships()
Collection endpoint returning the paymentGroup order relationships for the given parent
order.
|
protected java.util.List |
getPaymentGroupOrderRelationships(Order pOrder)
For the given order this method returns list of payment group order
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.
|
addCreatedItemUri, buildMemberUris, getCartUri, getCreatedItemUri, getDefaultLimit, getEmbeddedCartRelationshipName, getEmbeddedCommerceItemRelationshipName, getEmbeddedPaymentGroupRelationshipName, getEmbeddedShippingGroupRelationshipName, getOrder, getRelationshipCreated, getRelationships, getRepresentationModelBuilder, getRepresentationModelBuilder, getRepresentationModelBuilderWithCart, getRepresentationModelBuilderWithCart, getRepresentationModelBuilderWithPaging, getSelfLink, setDefaultLimit, setEmbeddedCartRelationshipName, setEmbeddedCommerceItemRelationshipName, setEmbeddedPaymentGroupRelationshipName, setEmbeddedShippingGroupRelationshipName
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static final java.lang.String CLASS_VERSION
public static final java.lang.String NO_PAYMENT_GROUP_ORDER_REL_FOUND
public PaymentGroupOrderRelationshipRestSubresource()
public void setOrderManager(OrderManager pOrderManager)
pOrderManager
- the order manager component which provides the methods to access
payment group manager and commerce item manager etcpublic OrderManager getOrderManager()
@Endpoint(id="/paymentGroupOrderRelationships/{relationshipId}#GET", isSingular=true, filterId="paymentGroupOrderRelationships.id-Default") public RepresentationModel getPaymentGroupOrderRelationship(java.lang.String pRelationshipId, java.lang.String pOrderId) throws RestException, CommerceException
Also embeds the paymentGroup summary in the PaymentGroupOrder relationship.
pRelationshipId
- Id of the PaymentGroupOrderRelationship to be retrievedpOrderId
- Id of the order for which shippingGroupCommerceItemRelationship is to be retrieved.RestException
- if an internal error occurred whilst getting the payment group order relationshipCommerceException
- if an internal error occurred whilst getting the payment group order relationship@Endpoint(id="/paymentGroupOrderRelationships#GET", isSingular=false, filterId="paymentGroupOrderRelationships-Default") public RepresentationModel getPaymentGroupOrderRelationships() throws RestException, CommerceException
RestException
- if an internal error occurred whilst getting the payment group order relationshipsCommerceException
- if an internal error occurred whilst getting the payment group order relationshipsprotected PaymentGroupOrderRelationship getPaymentGroupOrderRelationship(Order pOrder, java.lang.String pRelationshipId) throws RestException, CommerceException
pOrder
- the order from which to retrieve the relationshippRelationshipId
- the relationship to retrieveRestException
- if pRelationshipId is not found in the orderCommerceException
- if an internal error occurred whilst getting the payment group order relationshipsprotected java.util.List getPaymentGroupOrderRelationships(Order pOrder) throws CommerceException
pOrder
- the order containing the paymentGroup Order relationshipsCommerceException
- if any internal error occursprotected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.Object pState, java.lang.String pOrderId) throws RestException
Also embeds the paymentGroup summary.
pState
- the state that will be added to the representation model.pOrderId
- the id of the order , will be null for a cart.RestException