atg.repository.search.indexing.config
Class RankConfigItem

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.LoggingSupport
          atg.repository.search.indexing.config.RankConfigItem

All Implemented Interfaces:

ApplicationLogging, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, atg.search.adapter.customization.CustomizationItem

public class RankConfigItem
extends atg.nucleus.logging.LoggingSupport
implements atg.search.adapter.customization.CustomizationItem

The search engine will expect an object of this class for each search configuration in the repository.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

RankConfigItem(RankConfigAdapter pRankConfigAdapter, java.lang.String pId, java.lang.String pDisplayName)
Constructor.

Method Summary

atg.search.adapter.loader.AcquireSessionStatus	acquireCustomizations(atg.search.adapter.loader.AcquireSession pSession) Acquire customizations.
atg.search.adapter.customization.CustomizationType	getCustomizationType() Returns CustomizationType.RANK_CONFIG
java.lang.String	getDisplayName() Returns a display name for this item.
java.lang.String	getId() Returns the repository id of this search configuration repository item the XML in this instance presents.
RankConfigAdapter	getRankConfigAdapter()
long	getTimestamp() Search configuration doesn't support a timestamp so this method return 0.
java.lang.String	getXmlAsString() Call the SearchConfigurationXMLGenerator to get the XML for this search configuration item.
void	setRankConfigAdapter(RankConfigAdapter pRankConfigAdapter)

Methods inherited from class atg.nucleus.logging.LoggingSupport

getLogger, getLoggingForVlogging, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, setLogger, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

RankConfigItem

public RankConfigItem(RankConfigAdapter pRankConfigAdapter,
                      java.lang.String pId,
                      java.lang.String pDisplayName)

Constructor.

Parameters:

pRankConfigAdapter - RankConfigAdapter

pId - repository item id

Method Detail

getRankConfigAdapter

public RankConfigAdapter getRankConfigAdapter()

setRankConfigAdapter

public void setRankConfigAdapter(RankConfigAdapter pRankConfigAdapter)

getId

public java.lang.String getId()

Returns the repository id of this search configuration repository item the XML in this instance presents.

Specified by:

getId in interface atg.search.adapter.customization.CustomizationItem

Returns:

repository id

getDisplayName

public java.lang.String getDisplayName()

Returns a display name for this item. Defaults to the id.

Specified by:

getDisplayName in interface atg.search.adapter.customization.CustomizationItem

Returns:

display name for this item. Defaults to the id.

getCustomizationType

public atg.search.adapter.customization.CustomizationType getCustomizationType()

Returns CustomizationType.RANK_CONFIG

Specified by:

getCustomizationType in interface atg.search.adapter.customization.CustomizationItem

Returns:

CustomizationType.RANK_CONFIG

acquireCustomizations

public atg.search.adapter.loader.AcquireSessionStatus acquireCustomizations(atg.search.adapter.loader.AcquireSession pSession)
                                                                     throws atg.search.adapter.exception.AdapterException

Acquire customizations. Customization commands should be sent to to the session via processCommand. Unlike a ContentItemAdapter, this method should NOT spawn a new thread, and should only return when it is done sending commands.

Specified by:

acquireCustomizations in interface atg.search.adapter.customization.CustomizationItem

Parameters:

pSession - the session for the customization acquisition.

Throws:

atg.search.adapter.exception.AdapterException

getTimestamp

public long getTimestamp()

Search configuration doesn't support a timestamp so this method return 0.

Specified by:

getTimestamp in interface atg.search.adapter.customization.CustomizationItem

Returns:

0L

getXmlAsString

public java.lang.String getXmlAsString()
                                throws java.io.IOException

Call the SearchConfigurationXMLGenerator to get the XML for this search configuration item.

Returns:

search configuration xml

Throws:

java.io.IOException