atg.projects.store.assembler.cartridge

Class CrossCartridgeItemsLookupDroplet

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.assembler.cartridge.CrossCartridgeItemsLookupDroplet

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 CrossCartridgeItemsLookupDroplet
extends atg.servlet.DynamoServlet

This servlet looks for the items displayed in the configured cartridges. The obtained list of items is returned as a request parameter. To get the list of items, the droplet invokes the ContentItemTreeIterator component configured in the contentItemTreeIterator property. The ContentItemTreeIterator component performs the whole process of traversing content item tree and obtaining displayed items from the configured cartridges.

There are no required input parameters.

The following parameters are rendered:

output

Rendered if the list of items is NOT empty.

empty

Rendered if the list of items is empty.

The output parameters for this servlet are:

items

The list of items displayed in configured cartridges.

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/11.3/Endeca/Assembler/src/atg/projects/store/assembler/cartridge/CrossCartridgeItemsLookupDroplet.java#1 $$Change: 1385662 $

Author:

Natallia Paulouskaya

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

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

Method Summary

Modifier and Type	Method and Description
CrossCartridgeItemsLookup	getContentItemTreeIterator()
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method invokes the configured ContentItemTreeIterator, passing the root content item as a parameter.
void	setContentItemTreeIterator(CrossCartridgeItemsLookup pContentItemTreeIterator)

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

Class version string

Constructor Detail

CrossCartridgeItemsLookupDroplet

public CrossCartridgeItemsLookupDroplet()

Method Detail

getContentItemTreeIterator

public CrossCartridgeItemsLookup getContentItemTreeIterator()

Returns:

the ContentItemTreeIterator component responsible for walking through content item tree and looking for displayed items.

setContentItemTreeIterator

public void setContentItemTreeIterator(CrossCartridgeItemsLookup pContentItemTreeIterator)

Parameters:

pContentItemTreeIterator - - The ContentItemTreeIterator component responsible for walking through content item tree and looking for displayed items.

service

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

This method invokes the configured ContentItemTreeIterator, passing the root content item as a parameter.

The ContentItemTreeIterator traverses the content item tree looking for the specified content items and retrieves the displayed items from them. The found displayed items are returned as an items request parameter.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - - The HTTP request object.

pResponse - - The HTTP response object.

Throws:

javax.servlet.ServletException

java.io.IOException