atg.repository.search.indexing.config
Interface SearchUpdateCollector

All Known Implementing Classes:

ProductInventoryCollector, SKUInventoryCollector

public interface SearchUpdateCollector

Interface implemented by any class that will collect data for the SearchUpdateAdapter

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

java.lang.String	getCollectorName() Name this collector is known by for display and logging purposes.
boolean	isCollectorEnabled() Only enabled collectors are used.
SearchUpdateOutputProperty[]	processItem(java.lang.String pId, RepositoryItemDescriptor pIndexedItemDescriptor) Asks the collector to return any properties that should be added to the index for the given repository parameters.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getCollectorName

java.lang.String getCollectorName()

Name this collector is known by for display and logging purposes.

Returns:

String name

isCollectorEnabled

boolean isCollectorEnabled()

Only enabled collectors are used. A collector should return false here if it has not yet been configured.

Returns:

true if a collector is ready to be used by the SearchUpdateAdapter

processItem

SearchUpdateOutputProperty[] processItem(java.lang.String pId,
                                         RepositoryItemDescriptor pIndexedItemDescriptor)
                                         throws SearchUpdateException

Asks the collector to return any properties that should be added to the index for the given repository parameters.

Parameters:

pId - String repository item id

pIndexedItemDescriptor - item descriptor

Returns:

Array of SearchUpdateOutputProperty

Throws:

SearchUpdateException