atg.commerce.search.config
Class ProductInventoryCollector

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.commerce.search.config.ProductInventoryCollector

All Implemented Interfaces:

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, atg.repository.search.indexing.config.SearchUpdateCollector, MetaPropertyProvider, java.util.EventListener

public class ProductInventoryCollector
extends GenericService
implements atg.repository.search.indexing.config.SearchUpdateCollector, MetaPropertyProvider

An instance of this class can be configured to collect inventory data for any product in the product catalog
It will call into an InventoryManager to obtain the availability status for each childSKU and summarize the results for the product.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

ProductInventoryCollector()

Method Summary

java.lang.String	getCollectorName()
CollectorPropertyService	getCollectorPropertyService()
protected java.util.EnumMap<CollectorPropertyService.AvailabilityStatus,java.lang.Integer>	getOrderedMap()
java.util.Set<MetaProperty>	getProperties(java.util.Set<java.lang.String> pAcceptableTypes) Gets the set of properties that are available.
java.lang.String[]	getSummaryLogicStatuses()
boolean	isCollectorEnabled()
boolean	isNotDependOnMissedSku()
atg.repository.search.indexing.config.SearchUpdateOutputProperty[]	processItem(java.lang.String pId, RepositoryItemDescriptor pIndexedItemDescriptor)
void	setCollectorEnabled(boolean pCollectorEnabled)
void	setCollectorName(java.lang.String pCollectorName)
void	setCollectorPropertyService(CollectorPropertyService pCollectorPropertyService)
void	setNotDependOnMissedSku(boolean pNotDependOnMissedSku)
void	setSummaryLogicStatuses(java.lang.String[] pSummaryLogicStatuses)

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

Constructor Detail

ProductInventoryCollector

public ProductInventoryCollector()

Method Detail

isNotDependOnMissedSku

public boolean isNotDependOnMissedSku()

setNotDependOnMissedSku

public void setNotDependOnMissedSku(boolean pNotDependOnMissedSku)

setCollectorPropertyService

public void setCollectorPropertyService(CollectorPropertyService pCollectorPropertyService)

getCollectorPropertyService

public CollectorPropertyService getCollectorPropertyService()

setSummaryLogicStatuses

public void setSummaryLogicStatuses(java.lang.String[] pSummaryLogicStatuses)

getSummaryLogicStatuses

public java.lang.String[] getSummaryLogicStatuses()

getCollectorName

public java.lang.String getCollectorName()

Specified by:

getCollectorName in interface atg.repository.search.indexing.config.SearchUpdateCollector

setCollectorName

public void setCollectorName(java.lang.String pCollectorName)

isCollectorEnabled

public boolean isCollectorEnabled()

Specified by:

isCollectorEnabled in interface atg.repository.search.indexing.config.SearchUpdateCollector

setCollectorEnabled

public void setCollectorEnabled(boolean pCollectorEnabled)

processItem

public atg.repository.search.indexing.config.SearchUpdateOutputProperty[] processItem(java.lang.String pId,
                                                                                      RepositoryItemDescriptor pIndexedItemDescriptor)
                                                                               throws atg.repository.search.indexing.config.SearchUpdateException

Specified by:

processItem in interface atg.repository.search.indexing.config.SearchUpdateCollector

Throws:

atg.repository.search.indexing.config.SearchUpdateException

getProperties

public java.util.Set<MetaProperty> getProperties(java.util.Set<java.lang.String> pAcceptableTypes)

Gets the set of properties that are available. Only properties with a data type in the acceptable types set passed in should be included in the returned Set.

Specified by:

getProperties in interface MetaPropertyProvider

Parameters:

pAcceptableTypes - Set of valid String property data types.

Returns:

Set of MetaPropertiesHelper.Property properties

getOrderedMap

protected java.util.EnumMap<CollectorPropertyService.AvailabilityStatus,java.lang.Integer> getOrderedMap()

Returns:

EnumMap of availability status mapping to preferred order index