atg.commerce.search.config
Class CollectorPropertyService

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

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, java.util.EventListener

public class CollectorPropertyService
extends GenericService

Values and properties shared by the inventory or sales data collectors. If you have extended your InventoryManager to include different statuses then you will need to update the AvailabilityStatus enum in this class.

Nested Class Summary

static class

CollectorPropertyService.AvailabilityStatus Stock Availability Status enum of stock statuses that can be returned from the InventoryManager.

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

CollectorPropertyService()

Method Summary

java.lang.String	getAvailabilityStatusDisplayNameResource() Getter method for the resource key string to display the stockAvailabilityStatus property in the UI.
java.lang.String	getAvailabilityStatusOutputName() Getter method for the name of the stockAvailabilityStatus property as it will appear in the search index.
java.util.Map<java.lang.String,java.lang.String>	getAvailabilityStatusResourceMap() Getter for Map of availability status to resource key.
CatalogTools	getCatalogTools() Getter method for CatalogTools.
java.lang.String	getChildSKUsPropertyName() Getter method for the childSKUs property name in the catalog repository.
InventoryManager	getInventoryManager() Setter for the InventoryManager component to use.
java.text.MessageFormat	getKeyFormat() Getter for MessageFormat for the unique key property.
java.lang.String	getKeyFormatString() Getter for Format string for the unique key property.
java.lang.String	getResourceBundleName() Getter for resource bundle name.
void	setAvailabilityStatusDisplayNameResource(java.lang.String pAvailabilityStatusDisplayNameResource) Setter method for the resource key string to display the stockAvailabilityStatus property in the UI.
void	setAvailabilityStatusOutputName(java.lang.String pAvailabilityStatusOutputName) Setter method for the name of the stockAvailabilityStatus property as it will appear in the search index.
void	setAvailabilityStatusResourceMap(java.util.Map<java.lang.String,java.lang.String> pAvailabilityStatusResourceMap) Setter for Map of availability status to resource key.
void	setCatalogTools(CatalogTools pCatalogTools) Setter method for CatalogTools.
void	setChildSKUsPropertyName(java.lang.String pChildSKUsPropertyName) Setter method for the childSKUs property name in the catalog repository.
void	setInventoryManager(InventoryManager pInventoryManager) Getter for the InventoryManager component to use.
void	setKeyFormatString(java.lang.String pKeyFormatString) Setter for Format string for the unique key property.
void	setResourceBundleName(java.lang.String pResourceBundleName) Setter for resource bundle name.

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

CollectorPropertyService

public CollectorPropertyService()

Method Detail

getAvailabilityStatusResourceMap

public java.util.Map<java.lang.String,java.lang.String> getAvailabilityStatusResourceMap()

Getter for Map of availability status to resource key. Allows the different statuses to be displayed in a UI by looking up the resource bundle.

setAvailabilityStatusResourceMap

public void setAvailabilityStatusResourceMap(java.util.Map<java.lang.String,java.lang.String> pAvailabilityStatusResourceMap)

Setter for Map of availability status to resource key. Allows the different statuses to be displayed in a UI by looking up the resource bundle.

setAvailabilityStatusOutputName

public void setAvailabilityStatusOutputName(java.lang.String pAvailabilityStatusOutputName)

Setter method for the name of the stockAvailabilityStatus property as it will appear in the search index.

Parameters:

pAvailabilityStatusOutputName - String indexed property name

getAvailabilityStatusOutputName

public java.lang.String getAvailabilityStatusOutputName()

Getter method for the name of the stockAvailabilityStatus property as it will appear in the search index.

Returns:

String indexed property name

setAvailabilityStatusDisplayNameResource

public void setAvailabilityStatusDisplayNameResource(java.lang.String pAvailabilityStatusDisplayNameResource)

Setter method for the resource key string to display the stockAvailabilityStatus property in the UI.

Parameters:

pAvailabilityStatusDisplayNameResource - String resource key lookup

getAvailabilityStatusDisplayNameResource

public java.lang.String getAvailabilityStatusDisplayNameResource()

Getter method for the resource key string to display the stockAvailabilityStatus property in the UI.

Returns:

String resource key

getResourceBundleName

public java.lang.String getResourceBundleName()

Getter for resource bundle name. This is the resource bundle used to display the stockAvailabilityStatus property and the AvailabilityStatus enum values.

Returns:

String resource bundle name, defaults to atg.commerce.search.config.SearchCollectorResources

setResourceBundleName

public void setResourceBundleName(java.lang.String pResourceBundleName)

Setter for resource bundle name. This is the resource bundle used to display the stockAvailabilityStatus property and the AvailabilityStatus enum values.

Parameters:

pResourceBundleName - String resource bundle name

setKeyFormatString

public void setKeyFormatString(java.lang.String pKeyFormatString)

Setter for Format string for the unique key property. This is the string used to identify the document in the search index that should be updated with the new metaproperties. This string is stored for each row of the xml deployed by the SearchUpdateAdapter. Defaults to "$repositoryId=={0}" e.g. $repositoryId==prod1234 param pKeyFormatString String for MessageFormat to identify the search document to update

getKeyFormatString

public java.lang.String getKeyFormatString()

Getter for Format string for the unique key property. This is the string used to identify the document in the search index that should be updated with the new metaproperties. This string is stored for each row of the xml deployed by the SearchUpdateAdapter. Defaults to "$repositoryId=={0}" e.g. $repositoryId==prod1234 return String for MessageFormat to identify the search document to update

getKeyFormat

public java.text.MessageFormat getKeyFormat()

Getter for MessageFormat for the unique key property. Converts the KeyFormatString into a MessageFormat object.

Returns:

MessageFormat object for the key format string

setInventoryManager

public void setInventoryManager(InventoryManager pInventoryManager)

Getter for the InventoryManager component to use.

Parameters:

pInventoryManager - InventoryManager component to use.

getInventoryManager

public InventoryManager getInventoryManager()

Setter for the InventoryManager component to use.

Returns:

InventoryManager component to use.

setCatalogTools

public void setCatalogTools(CatalogTools pCatalogTools)

Setter method for CatalogTools. It is used to identify the base product and sku item types. This is used by the inventory collector to iterator over the catalog.

Parameters:

pCatalogTools - CatalogTools to use.

getCatalogTools

public CatalogTools getCatalogTools()

Getter method for CatalogTools. It is used to identify the base product and sku item types. This is used by the inventory collector to iterator over the catalog.

Returns:

CatalogTools to use.

setChildSKUsPropertyName

public void setChildSKUsPropertyName(java.lang.String pChildSKUsPropertyName)

Setter method for the childSKUs property name in the catalog repository. Defaults to "childSKUs"

Parameters:

pChildSKUsPropertyName - String property name.

getChildSKUsPropertyName

public java.lang.String getChildSKUsPropertyName()

Getter method for the childSKUs property name in the catalog repository. Defaults to "childSKUs" return String property name.