atg.commerce.search.refinement
Class CommerceFacetManager

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.repository.search.refinement.FacetManager
              atg.commerce.search.refinement.CommerceFacetManager

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 CommerceFacetManager
extends FacetManager

CommerceFacetManager extends FacetManager and provides commerce specific functionality to the refinement repository.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected CommerceRefinementConfigurationPropertyManager	mCommerceRefinementConfigurationPropertyManager

Fields inherited from class atg.repository.search.refinement.FacetManager

mRefinementConfigurationPropertyManager, mRefinementElementPropertyManager, mRepository, mSearchFacetId, mSortOptionPropertyManager

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

CommerceFacetManager()

Method Summary

CatalogTools	getCatalogTools()
java.lang.String	getCategoryFacetPropertyValue()
RepositoryItem	getCommerceRefineConfigById(java.lang.String pCommerceRefineConfigId) Returns the commerce refinement configuration object with the given id.
CommerceRefinementConfigurationPropertyManager	getCommerceRefinementConfigurationPropertyManager()
RefinementConfiguration	getGlobalRefinementConfiguration() Returns the global refinement config object.
IdGenerator	getIdGenerator()
boolean	isCategoryFacet(atg.repository.search.refinement.RefinementFacet pFacet)
boolean	isValueACategoryId(java.lang.String pValueToCheck) Determines whether the given value is the ID of a category.
void	setCatalogTools(CatalogTools pCatalogTools)
void	setCategoryFacetPropertyValue(java.lang.String pCategoryFacetPropertyValue)
void	setCommerceRefinementConfigurationPropertyManager(CommerceRefinementConfigurationPropertyManager pCommerceRefinementConfigurationPropertyManager)
void	setIdGenerator(IdGenerator pIdGenerator)

Methods inherited from class atg.repository.search.refinement.FacetManager

getItem, getRefineConfigById, getRefineElementById, getRefinementConfigurationPropertyManager, getRefinementElementPropertyManager, getRepository, getSearchFacetId, getSortOptionById, getSortOptionPropertyManager, setRefinementConfigurationPropertyManager, setRefinementElementPropertyManager, setRepository, setSearchFacetId, setSortOptionPropertyManager

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

Class version string

mCommerceRefinementConfigurationPropertyManager

protected CommerceRefinementConfigurationPropertyManager mCommerceRefinementConfigurationPropertyManager

Constructor Detail

CommerceFacetManager

public CommerceFacetManager()

Method Detail

getCommerceRefinementConfigurationPropertyManager

public CommerceRefinementConfigurationPropertyManager getCommerceRefinementConfigurationPropertyManager()

setCommerceRefinementConfigurationPropertyManager

public void setCommerceRefinementConfigurationPropertyManager(CommerceRefinementConfigurationPropertyManager pCommerceRefinementConfigurationPropertyManager)

getCategoryFacetPropertyValue

public java.lang.String getCategoryFacetPropertyValue()

Returns:

The value of the 'property' property for facets that represent categories

setCategoryFacetPropertyValue

public void setCategoryFacetPropertyValue(java.lang.String pCategoryFacetPropertyValue)

Parameters:

pCategoryFacetPropertyValue - The value to set for the 'property' property for facets that represent categories.

getIdGenerator

public IdGenerator getIdGenerator()

Returns:

The ID generator that holds the ID spaces for different repository items

setIdGenerator

public void setIdGenerator(IdGenerator pIdGenerator)

Parameters:

pIdGenerator - The ID generator to set.

getCatalogTools

public CatalogTools getCatalogTools()

Returns:

The CatalogTools instance.

setCatalogTools

public void setCatalogTools(CatalogTools pCatalogTools)

Parameters:

pCatalogTools - The CatalogTools instance to set.

getCommerceRefineConfigById

public RepositoryItem getCommerceRefineConfigById(java.lang.String pCommerceRefineConfigId)
                                           throws RepositoryException

Returns the commerce refinement configuration object with the given id. The item has a descriptor type of "commerceRefineConfig" in the repository.

Parameters:

pCommerceRefineConfigId - String id of the commerce refinement configuration to retrieve

Returns:

a RepositoryItem object if the item can be found, otherwise null is returned.

Throws:

RepositoryException

getGlobalRefinementConfiguration

public RefinementConfiguration getGlobalRefinementConfiguration()
                                                         throws RepositoryException

Returns the global refinement config object.

Returns:

Global RefinementConfiguration

Throws:

RepositoryException

isCategoryFacet

public boolean isCategoryFacet(atg.repository.search.refinement.RefinementFacet pFacet)

isValueACategoryId

public boolean isValueACategoryId(java.lang.String pValueToCheck)

Determines whether the given value is the ID of a category.

Parameters:

pValueToCheck -

Returns:

true if the value is a category Id, false otherwise.