atg.commerce.search.config
Class ProductInventoryCollector
java.lang.Object
atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.commerce.search.config.ProductInventoryCollector
- All Implemented Interfaces:
- NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, SearchUpdateCollector, MetaPropertyProvider, java.util.EventListener
public class ProductInventoryCollector
- extends GenericService
- implements 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 interface atg.nucleus.logging.TraceApplicationLogging |
DEFAULT_LOG_TRACE_STATUS |
Methods inherited from class atg.nucleus.GenericService |
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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 |
CLASS_VERSION
public static final java.lang.String CLASS_VERSION
- Class version string
- See Also:
- Constant Field Values
ProductInventoryCollector
public ProductInventoryCollector()
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()
- Description copied from interface:
SearchUpdateCollector
- Name this collector is known by for display and logging purposes.
- Specified by:
getCollectorName
in interface SearchUpdateCollector
- Returns:
- String name
setCollectorName
public void setCollectorName(java.lang.String pCollectorName)
isCollectorEnabled
public boolean isCollectorEnabled()
- Description copied from interface:
SearchUpdateCollector
- Only enabled collectors are used.
A collector should return false here if it has not yet been configured.
- Specified by:
isCollectorEnabled
in interface SearchUpdateCollector
- Returns:
- true if a collector is ready to be used by the SearchUpdateAdapter
setCollectorEnabled
public void setCollectorEnabled(boolean pCollectorEnabled)
processItem
public SearchUpdateOutputProperty[] processItem(java.lang.String pId,
RepositoryItemDescriptor pIndexedItemDescriptor)
throws SearchUpdateException
- Description copied from interface:
SearchUpdateCollector
- Asks the collector to return any properties that should be added to the index for the
given repository parameters.
- Specified by:
processItem
in interface SearchUpdateCollector
- Parameters:
pId
- String repository item idpIndexedItemDescriptor
- item descriptor
- Returns:
- Array of SearchUpdateOutputProperty
- Throws:
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