atg.projects.store.droplet

Class PropertyValueCollection

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.PropertyValueCollection

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

Creates a collection of property values for a collection of repository items. An optional CollectionFilter can be applied to the values to filter and/or sort them.

Input Parameters:
items - The collection of items that will be used to create the collection of property values. propertyName - The property whose values will populate the resultant collection. filter - An optional CollectionFilter to filter the resultant collection

Open Parameters:
output - Rendered when there is atleast 1 entry in the resultant property values collection. empty - Rendered if there is no entrys in the resultant property values collection. error - Rendered if an exception occurs

Output Parameters:
None

Version:

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

Author:

ATG

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string.
static java.lang.String	EMPTY_OPARAM Empty parameter name.
static java.lang.String	ERROR_OPARAM Error parameter name.
static atg.nucleus.naming.ParameterName	FILTER_PARAM Filter parameter name.
static atg.nucleus.naming.ParameterName	ITEMS_PARAM Items parameter name.
protected StoreCatalogTools	mCatalogTools Catalog tools.
protected atg.service.collections.filter.CachedCollectionFilter	mFilter Filter.
static java.lang.String	OUTPUT_OPARAM Output parameter name.
static atg.nucleus.naming.ParameterName	PROPERTY_NAME_PARAM Proeprty name parameter name.
static java.lang.String	VALUES_PARAM Values 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
PropertyValueCollection()

Method Summary

Modifier and Type	Method and Description
StoreCatalogTools	getCatalogTools()
atg.service.collections.filter.CachedCollectionFilter	getFilter()
protected atg.service.collections.filter.CachedCollectionFilter	getFilter(atg.servlet.DynamoHttpServletRequest pRequest)
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Renders the output oparam with a collection of optionally filtered/sorted values.
void	setCatalogTools(StoreCatalogTools pCatalogTools) Sets the catalogTools.
void	setFilter(atg.service.collections.filter.CachedCollectionFilter pFilter) Sets the the default filter to execute.

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

ITEMS_PARAM

public static final atg.nucleus.naming.ParameterName ITEMS_PARAM

Items parameter name.

PROPERTY_NAME_PARAM

public static final atg.nucleus.naming.ParameterName PROPERTY_NAME_PARAM

Proeprty name parameter name.

FILTER_PARAM

public static final atg.nucleus.naming.ParameterName FILTER_PARAM

Filter parameter name.

VALUES_PARAM

public static final java.lang.String VALUES_PARAM

Values parameter name.

See Also:

Constant Field Values

OUTPUT_OPARAM

public static final java.lang.String OUTPUT_OPARAM

Output parameter name.

See Also:

Constant Field Values

EMPTY_OPARAM

public static final java.lang.String EMPTY_OPARAM

Empty parameter name.

See Also:

Constant Field Values

ERROR_OPARAM

public static final java.lang.String ERROR_OPARAM

Error parameter name.

See Also:

Constant Field Values

mCatalogTools

protected StoreCatalogTools mCatalogTools

Catalog tools.

mFilter

protected atg.service.collections.filter.CachedCollectionFilter mFilter

Filter.

Constructor Detail

PropertyValueCollection

public PropertyValueCollection()

Method Detail

getCatalogTools

public StoreCatalogTools getCatalogTools()

Returns:

the catalog tools.

setCatalogTools

public void setCatalogTools(StoreCatalogTools pCatalogTools)

Sets the catalogTools.

Parameters:

pCatalogTools - - catalog tools.

setFilter

public void setFilter(atg.service.collections.filter.CachedCollectionFilter pFilter)

Sets the the default filter to execute.

Parameters:

pFilter - - filter

getFilter

public atg.service.collections.filter.CachedCollectionFilter getFilter()

Returns:

the default filter to execute.

service

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

Renders the output oparam with a collection of optionally filtered/sorted values. Renders the empty oparam if the collection of items or values is empty.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

getFilter

protected atg.service.collections.filter.CachedCollectionFilter getFilter(atg.servlet.DynamoHttpServletRequest pRequest)

Parameters:

pRequest - DynamoHttpServletRequest value

Returns:

the filter param from the request. if the param was not provided, the configured filter is returned.