atg.commerce.pricing.restresources

Class CurrencyRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.pricing.restresources.CurrencyRestResource

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.pricing.restresources.CurrencyRestResource")
public class CurrencyRestResource
extends GenericService

Class that defines the RESTful endpoints for Currencies

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	CURRENCY_CODE
static java.lang.String	CURRENCY_SYMBOL
static java.lang.String	DISPLAY_NAME
static java.lang.String	FRACTIONAL_DIGITS
static java.lang.String	NUMERIC_CODE

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

Method Summary

Modifier and Type	Method and Description
RepresentationModel	getCurrency(java.lang.String pLocaleId) Endpoint that provides a representation of a Currency from its Locale ID
java.util.Map<java.lang.String,java.lang.Object>	getCurrencyDetails(java.util.Locale pLocale) Supporting method used to build up the Map representation of a Currency that will be parsed by the REST Framework.
PricingTools	getPricingTools() Returns property PricingTools
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
void	setPricingTools(PricingTools pPricingTools) Sets property PricingTools

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

CURRENCY_CODE

public static final java.lang.String CURRENCY_CODE

See Also:

Constant Field Values

DISPLAY_NAME

public static final java.lang.String DISPLAY_NAME

See Also:

Constant Field Values

FRACTIONAL_DIGITS

public static final java.lang.String FRACTIONAL_DIGITS

See Also:

Constant Field Values

NUMERIC_CODE

public static final java.lang.String NUMERIC_CODE

See Also:

Constant Field Values

CURRENCY_SYMBOL

public static final java.lang.String CURRENCY_SYMBOL

See Also:

Constant Field Values

Constructor Detail

CurrencyRestResource

public CurrencyRestResource()

Method Detail

setPricingTools

public void setPricingTools(PricingTools pPricingTools)

Sets property PricingTools

Parameters:

pPricingTools - - the PricingTools object to set

getPricingTools

public PricingTools getPricingTools()

Returns property PricingTools

Returns:

PricingTools - the PricingTools component to be returned

getCurrency

@Endpoint(id="/currencies/{localeId}#GET",
          isSingular=true,
          filterId="currencies.id-Default")
public RepresentationModel getCurrency(java.lang.String pLocaleId)
                                                                                                                                                  throws RestException

Endpoint that provides a representation of a Currency from its Locale ID

Parameters:

pLocaleId - - the locale from which the currency details will be retrieved

Returns:

model representation of the currency

Throws:

RestException

getCurrencyDetails

public java.util.Map<java.lang.String,java.lang.Object> getCurrencyDetails(java.util.Locale pLocale)

Supporting method used to build up the Map representation of a Currency that will be parsed by the REST Framework.

Parameters:

pLocale - - the Locale for which we derive the currency representation

Returns:

Map containing the properties of the Currency we require: currencyCode, displayName, fractionalDigits, numericCode, symbol

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