atg.commerce.order.restresources

Class ShippingMethodRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractShippingMethodRestResource

atg.commerce.order.restresources.ShippingMethodRestResource

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.ShippingMethodRestResource")
public class ShippingMethodRestResource
extends AbstractShippingMethodRestResource

This class implements endpoints for the ShippingMethod top level resource.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

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

FAILED_SHIPPING_METHODS, METHOD_ID_KEY, RESOURCE_NAME, sResourceBundle, UNKNOWN_SHIPPING_METHOD

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

Method Summary

Modifier and Type	Method and Description
protected ShippingGroup	getShippingGroup() Returns a shipping group that can be used for ShippingEngine calls.
RepresentationModel	getShippingMethod(java.lang.String pShippingMethodId) Returns a representation model of a single shipping method.
RepresentationModel	listShippingMethods() Returns a list of shipping methods that are available for any shipping group.

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

buildMemberUris, getAllShippingMethods, getRepresentationModelBuilder, getRepresentationModelBuilder, getShippingMethod, getShippingPricingEngine, listShippingMethods, setShippingPricingEngine

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

Constructor Detail

ShippingMethodRestResource

public ShippingMethodRestResource()

Method Detail

listShippingMethods

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

Returns a list of shipping methods that are available for any shipping group. Use cart/shippingGroups/shippingMethods to get the list of shipping methods that are appropriate for a specific shipping group or address.

Returns:

representation model containing a list of shipping methods

Throws:

RestException - if input ID is invalid or an internal error occurs

getShippingMethod

@Endpoint(id="/shippingMethods/{shippingMethodId}#GET",
          isSingular=true,
          filterId="shippingMethods.id-Default")
public RepresentationModel getShippingMethod(java.lang.String pShippingMethodId)
                                                                                                                                                                          throws RestException

Returns a representation model of a single shipping method.

Parameters:

pShippingMethodId - name of the shipping method

Returns:

representation model of the shipping method

Throws:

RestException - if input ID is invalid or an internal error occurs

getShippingGroup

protected ShippingGroup getShippingGroup()

Returns a shipping group that can be used for ShippingEngine calls.

Returns:

shipping group