atg.commerce.search.refinement.admin
Class RefineConfigItem

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.LoggingSupport
          atg.commerce.search.refinement.admin.RefineConfigItem

All Implemented Interfaces:

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

public class RefineConfigItem
extends atg.nucleus.logging.LoggingSupport
implements atg.search.adapter.customization.CustomizationItem, RefinementConfigurationXMLHandler

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

RefineConfigItem(RefinementConfigurationGenerator pGenerator)
Constructs an instanceof RefineConfigItem

Method Summary

atg.search.adapter.loader.AcquireSessionStatus	acquireCustomizations(atg.search.adapter.loader.AcquireSession pSession) generate xml for each refine config
atg.search.adapter.customization.CustomizationType	getCustomizationType() get CustomizationType
java.lang.String	getDisplayName() get DisplayName
java.lang.String	getId() get Id
atg.search.adapter.loader.AcquireSession	getSession() get Session
long	getTimestamp() get Timestamp
void	handleRefinementConfigurationXML(byte[] pRefinementConfigurationXML) implement the RefinementConfigurationXMLHandler interface
void	setDisplayName(java.lang.String pDisplayName) set DisplayName
void	setId(java.lang.String pId) set Id
void	setSession(atg.search.adapter.loader.AcquireSession pSession) set Session

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, 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 java.lang.String CLASS_VERSION

Class version string

Constructor Detail

RefineConfigItem

public RefineConfigItem(RefinementConfigurationGenerator pGenerator)

Constructs an instanceof RefineConfigItem

Method Detail

setId

public void setId(java.lang.String pId)

set Id

Parameters:

pId - the Id

getId

public java.lang.String getId()

get Id

Specified by:

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

Returns:

the Id

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)

set DisplayName

Parameters:

pDisplayName - the DisplayName

getDisplayName

public java.lang.String getDisplayName()

get DisplayName

Specified by:

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

Returns:

the DisplayName

getCustomizationType

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

get CustomizationType

Specified by:

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

Returns:

the CustomizationType

getTimestamp

public long getTimestamp()

get Timestamp

Specified by:

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

Returns:

the Timestamp

setSession

public void setSession(atg.search.adapter.loader.AcquireSession pSession)

set Session

Parameters:

pSession - the Session

getSession

public atg.search.adapter.loader.AcquireSession getSession()

get Session

Returns:

the Session

acquireCustomizations

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

generate xml for each refine config

Specified by:

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

Throws:

atg.search.adapter.exception.AdapterException

handleRefinementConfigurationXML

public void handleRefinementConfigurationXML(byte[] pRefinementConfigurationXML)
                                      throws atg.repository.search.indexing.IndexingException

implement the RefinementConfigurationXMLHandler interface

Specified by:

handleRefinementConfigurationXML in interface RefinementConfigurationXMLHandler

Throws:

atg.repository.search.indexing.IndexingException