atg.projects.store.droplet

Class CategoryBySiteDroplet

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.projects.store.droplet.CategoryBySiteDroplet

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, atg.servlet.ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class CategoryBySiteDroplet
extends atg.servlet.DynamoServlet

This droplet retrieves a default parent category from a passed in product item and site ID. If a default category ID is found, it will be set as as the 'categoryId' output parameter value.

Input Parameters:

product

The product RepositoryItem that we want to retrieve the parentCategory of.

siteId

The siteId of the site we want to get the corresponding parent category of.

Open Parameters:

output

Always rendered.

Output Parameters:

categoryId

The category ID of the preferred parent category that is relevant to the passed in site ID. Otherwise null.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/11.3/EStore/src/atg/projects/store/droplet/CategoryBySiteDroplet.java#1 $$Change: 1385662 $

Author:

David Stewart

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CATEGORY_ID Category id output parameter name.
static java.lang.String	CLASS_VERSION Class version string
protected atg.commerce.catalog.CatalogTools	mCatalogTools
static java.lang.String	OUTPUT Output parameter name.
static atg.nucleus.naming.ParameterName	PRODUCT Product parameter name.
static atg.nucleus.naming.ParameterName	SITE_ID Site id parameter name

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

Method Summary

Modifier and Type	Method and Description
atg.commerce.catalog.CatalogTools	getCatalogTools()
java.lang.String	getDefaultCategoryId(atg.repository.RepositoryItem pProduct, java.lang.String pSiteId) Retrieve the preferred parent category for the given product and site.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Service method, see API definition.
void	setCatalogTools(atg.commerce.catalog.CatalogTools pCatalogTools)

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

Class version string

See Also:

Constant Field Values

SITE_ID

public static final atg.nucleus.naming.ParameterName SITE_ID

Site id parameter name

PRODUCT

public static final atg.nucleus.naming.ParameterName PRODUCT

Product parameter name.

CATEGORY_ID

public static final java.lang.String CATEGORY_ID

Category id output parameter name.

See Also:

Constant Field Values

OUTPUT

public static final java.lang.String OUTPUT

Output parameter name.

See Also:

Constant Field Values

mCatalogTools

protected atg.commerce.catalog.CatalogTools mCatalogTools

Constructor Detail

CategoryBySiteDroplet

public CategoryBySiteDroplet()

Method Detail

setCatalogTools

public void setCatalogTools(atg.commerce.catalog.CatalogTools pCatalogTools)

Parameters:

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

getCatalogTools

public atg.commerce.catalog.CatalogTools getCatalogTools()

Returns:

The CatalogTools object to use when looking up products categories.

service

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

Service method, see API definition.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - DynamoHttpSevletRequest

pResponse - DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

getDefaultCategoryId

public java.lang.String getDefaultCategoryId(atg.repository.RepositoryItem pProduct,
                                             java.lang.String pSiteId)

Retrieve the preferred parent category for the given product and site.

Parameters:

pProduct - The product RepositoryItem that will be used to determine the parent category.

pSiteId - The site ID that will be used to determine the parent category.

Returns:

The preferred category Id of the given product and siteId. otherwise null.