atg.commerce.order.restresources

Class AbstractShippingMethodRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.restresources.AbstractShippingMethodRestResource

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:

ShippingMethodRestResource, ShippingMethodRestSubresource

public abstract class AbstractShippingMethodRestResource
extends GenericService

This class contains shared logic for the ShippingMethod top level and sub-resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	FAILED_SHIPPING_METHODS
static java.lang.String	METHOD_ID_KEY
static java.lang.String	RESOURCE_NAME
static java.util.ResourceBundle	sResourceBundle Resource Bundle
static java.lang.String	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
AbstractShippingMethodRestResource()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String[]	buildMemberUris(java.util.Collection<java.lang.String> pMembers, <any> pQueryParams) Build the members URIs for the given list of items of Strings.
protected java.util.List<java.lang.String>	getAllShippingMethods(ShippingGroup pShippingGroup) Returns a list of shipping methods that are available for a given shipping group.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.util.Collection<java.lang.String> pMembers) Gets the RepresentationModel.Builder with the given collection of Strings being used to build member URIs.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
RepresentationModel	getShippingMethod(ShippingGroup pShippingGroup, java.lang.String pShippingMethodId) Returns a representation model of a single shipping method.
ShippingPricingEngine	getShippingPricingEngine() Returns the shipping pricing engine to consult for available shipping methods
RepresentationModel	listShippingMethods(ShippingGroup pShippingGroup) Returns a list of shipping methods that are available for a given shipping group.
void	setShippingPricingEngine(ShippingPricingEngine pShippingPricingEngine) Sets the shipping pricing engine to consult for available shipping methods

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

UNKNOWN_SHIPPING_METHOD

public static final java.lang.String UNKNOWN_SHIPPING_METHOD

See Also:

Constant Field Values

FAILED_SHIPPING_METHODS

public static final java.lang.String FAILED_SHIPPING_METHODS

See Also:

Constant Field Values

METHOD_ID_KEY

public static final java.lang.String METHOD_ID_KEY

See Also:

Constant Field Values

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

sResourceBundle

public static java.util.ResourceBundle sResourceBundle

Resource Bundle

Constructor Detail

AbstractShippingMethodRestResource

public AbstractShippingMethodRestResource()

Method Detail

setShippingPricingEngine

public void setShippingPricingEngine(ShippingPricingEngine pShippingPricingEngine)

Sets the shipping pricing engine to consult for available shipping methods

Parameters:

pShippingPricingEngine - reference to ShippingPricingEngine

getShippingPricingEngine

public ShippingPricingEngine getShippingPricingEngine()

Returns the shipping pricing engine to consult for available shipping methods

Returns:

reference to ShippingPricingEngine

listShippingMethods

public RepresentationModel listShippingMethods(ShippingGroup pShippingGroup)
                                        throws RestException

Returns a list of shipping methods that are available for a given shipping group.

Returns:

representation model containing a list of shipping methods

Throws:

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

getShippingMethod

public RepresentationModel getShippingMethod(ShippingGroup pShippingGroup,
                                             java.lang.String pShippingMethodId)
                                      throws RestException

Returns a representation model of a single shipping method.

Parameters:

pShippingGroup - the shipping group to use for possible shipping methods

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

getAllShippingMethods

protected java.util.List<java.lang.String> getAllShippingMethods(ShippingGroup pShippingGroup)
                                                          throws RestException

Returns a list of shipping methods that are available for a given shipping group.

Returns:

list of shipping methods

Throws:

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

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.Object pState)

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

Parameters:

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

Returns:

RepresentationModel.Builder containing the state

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.util.Collection<java.lang.String> pMembers)
                                                             throws RestException

Gets the RepresentationModel.Builder with the given collection of Strings being used to build member URIs.

Parameters:

pMembers - the members that will be added to the representation model

Returns:

RepresentationModel.Builder containing the member uris

Throws:

RestException - if the member URIs could not be built

buildMemberUris

protected java.lang.String[] buildMemberUris(java.util.Collection<java.lang.String> pMembers,
                                             <any> pQueryParams)
                                      throws RestException

Build the members URIs for the given list of items of Strings.

Parameters:

pMembers - a list of Strings from which to build the member URIs

pQueryParams - optional map of query param key/value pairs to be added to any built uris, null if none

Returns:

an array of URI's where each element represents a GET URI

Throws:

RestException - if a problem occurred whilst building the member URIs