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.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 the parent categories from a passed in product item. It then iterates through each category checking if the siteIds property contains the passed in siteId. If the siteId is matched, a 'categoryId' output parameter is set with the category id of the matched category.

Input Parameters:

product

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

siteId

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

Open Parameters:

output

Always rendered.

Output Parameters:

categoryId

The category id of the category that is relevant to the passed in site id. Will return an empty string in the categoryId parameter in no match is found.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/EStore/src/atg/projects/store/droplet/CategoryBySiteDroplet.java#2 $$Change: 791366 $

Author:

David Stewart

Field Summary

static java.lang.String	CATEGORY_ID Category id output parameter name.
static java.lang.String	CLASS_VERSION Class version string
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

CategoryBySiteDroplet()

Method Summary

StoreCatalogProperties	getCatalogProperties()
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Service method, see API definition.
void	setCatalogProperties(StoreCatalogProperties pCatalogProperties)

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

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, toString, 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

Constructor Detail

CategoryBySiteDroplet

public CategoryBySiteDroplet()

Method Detail

getCatalogProperties

public StoreCatalogProperties getCatalogProperties()

Returns:

the StoreCatalogProperties component.

setCatalogProperties

public void setCatalogProperties(StoreCatalogProperties pCatalogProperties)

Parameters:

pCatalogProperties - - The StoreCatalogProperties component.

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