atg.commerce.catalog

Class UnitOfMeasureDroplet

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.nucleus.TimedOperationService

atg.nucleus.servlet.ServletService

atg.nucleus.servlet.HttpServletService

atg.servlet.DynamoServlet

atg.commerce.catalog.UnitOfMeasureDroplet

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, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class UnitOfMeasureDroplet
extends DynamoServlet

This droplet will provide the fractional breakdown for a specific unit of measure. It can be used to determine if a product or sku accepts fractional quantities. Depending on how a unit of measure is configured, it will indicate whether it can be sold in fractional quantities or not. If it can, the configuration can provide either a list of UnitOfMeasureOption beans with values and labels for a unit of measure, or an increment value. Both of these can be used by a page coder to create a widget for example. Example: This code example shows the unit of measure droplet being called with an input parameter of a product id. The droplet renders the fractional output parameter indicating if the product is flagged as fractional quantities allowed. The droplet also renders the type output parameter indicating if the unit of measure is of 'increment' type or 'options' type. As the product is increment type it renders the increment output parameter which is a double value of what increments quantities should be supplied in.

   
   <dsp:importbean bean="/atg/commerce/catalog/UnitOfMeasureDroplet"/>
   <dsp:droplet name="UnitOfMeasureDroplet">
     <dsp:param name="product"  param="product.repositoryId"/>
     <dsp:oparam name="output">
       <dsp:valueof param="fractional"/>
       <dsp:valueof param="type"/>
       <dsp:valueof param="increment"/>
     </dsp:oparam>
   </dsp:droplet>
   
 

Another example demonstrates how the droplet may be used to render different logic for fractional or non fractional products.

   
 <dsp:importbean bean="/atg/dynamo/droplet/Switch"/>
 <dsp:importbean bean="/atg/commerce/catalog/UnitOfMeasureDroplet"/>
 <dsp:droplet name="UnitOfMeasureDroplet">
   <dsp:param name="product" param="product.repositoryId"/>
   <dsp:oparam name="output">
   <dsp:droplet name="Switch">
     <dsp:param name="value" param="fractional"/>
     <dsp:oparam name="false">
       non-fractional logic
     </dsp:oparam>
     <dsp:oparam name="true">
       fractional logic
     </dsp:oparam>
   </dsp:droplet>
   </dsp:oparam>
 </dsp:droplet>
   
 

The following input parameters can be set:

unit

The value corresponding to the unit_of_measure property value of a product or sku. This parameter is optional if determining if the commerce item/product is fractional.

item

The commerce item to be inspected. This parameter is optional. If specified, the product and sku parameters are ignored.

product

The product to be inspected. This parameter is optional. The value may be either the product repository item itself or the product id as a string.

sku

The sku to be inspected. This parameter is optional. The value may be either the sku repository item itself or the sku id as a string. However, if a value for product is also supplied, then product and sku must either both be repository items or both be strings. Providing one as a product and the other as a string is an error.

language (optional)

The language of the locale to use

country (optional)

The country of the locale to use

One can configure this droplet to define a mapping from a key to an alternate set of repositories.

The following output parameters are rendered or set:

output

Rendered in normal cases. The fractional parameter will be set. The type, options, and increment parameters will be set if the unit parameter is specified or if the sku or product has a unitOfMeasure property value.

fractional

Will indicate if fractional quantities are allowed

type

Will indicate the type of fractional breakdown (options or increment)

options

An ordered list of UnitOfMeasure beans, containing the measurements (e.g. 0.25, 0.5, etc) and associated labels (1/4 lb, 1/2lb, etc) for each.

increment

Contains a decimal value that will effectively represent the quantity increments the unit should be sold in. This could be used to help create some type of stepper control on a UI.

error

Rendered if an error occurred

errorMessage

An error message, set if the error parameter is rendered

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected CatalogTools	mCatalogTools

Fields inherited from class atg.servlet.DynamoServlet

mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService

SERVLET_INFO_KEY

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

Method Summary

Modifier and Type	Method and Description
CatalogTools	getCatalogTools()
CommerceItemManager	getCommerceItemManager() Returns property commerceItemManager
java.util.Locale	getDefaultLocale() Returns property DefaultLocale.
protected java.util.Locale	getLocale(DynamoHttpServletRequest pRequest) Gets the locale to use.
UnitOfMeasureManager	getUnitOfMeasureManager() Gets the unit of measure manager
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Determine if a product, product and sku or commerceItem accepts fractional quantities.
void	setCatalogTools(CatalogTools pCatalogTools)
void	setCommerceItemManager(CommerceItemManager pCommerceItemManager) Sets property commerceItemManager
void	setDefaultLocale(java.util.Locale pDefaultLocale) Sets property DefaultLocale
void	setUnitOfMeasureManager(UnitOfMeasureManager pUnitOfMeasureManager) Sets the unit of measure manager

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

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 java.lang.String CLASS_VERSION

mCatalogTools

protected CatalogTools mCatalogTools

Constructor Detail

UnitOfMeasureDroplet

public UnitOfMeasureDroplet()

Method Detail

setDefaultLocale

public void setDefaultLocale(java.util.Locale pDefaultLocale)

Sets property DefaultLocale

getDefaultLocale

public java.util.Locale getDefaultLocale()

Returns property DefaultLocale. If the property value is null, then JVM's default locale is returned.

setUnitOfMeasureManager

public void setUnitOfMeasureManager(UnitOfMeasureManager pUnitOfMeasureManager)

Sets the unit of measure manager

Parameters:

pUnitOfMeasureManager -

getUnitOfMeasureManager

public UnitOfMeasureManager getUnitOfMeasureManager()

Gets the unit of measure manager

Returns:

the unit of measure manager

getCommerceItemManager

public CommerceItemManager getCommerceItemManager()

Returns property commerceItemManager

Returns:

returns property commerceItemManager

setCommerceItemManager

public void setCommerceItemManager(CommerceItemManager pCommerceItemManager)

Sets property commerceItemManager

Parameters:

pCommerceItemManager - the value to set for property commerceItemManager

setCatalogTools

public void setCatalogTools(CatalogTools pCatalogTools)

Parameters:

pCatalogTools - The CatalogTools object to use when looking up products or categories.

getCatalogTools

public CatalogTools getCatalogTools()

Returns:

The CatalogTools object to use when looking up products categories.

service

public void service(DynamoHttpServletRequest pRequest,
                    DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

Determine if a product, product and sku or commerceItem accepts fractional quantities. Depending on how a unit of measure is configured,It will indicate whether it can be sold in fractional quantities or not. If it can, the configuration can provide either a list of UnitOfMeasureOption beans with values and labels for a unit of measure,or an increment value.

Overrides:

service in class DynamoServlet

Parameters:

pRequest - a value of type 'DynamoHttpServletRequest'

pResponse - a value of type 'DynamoHttpServletResponse'

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

getLocale

protected java.util.Locale getLocale(DynamoHttpServletRequest pRequest)

Gets the locale to use.

Parameters:

pRequest - The request

Returns:

A Locale to be used by this droplet