atg.commerce.catalog
Class CatalogNavHistory

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.ApplicationLoggingImpl
          atg.repository.servlet.NavHistory
              atg.commerce.catalog.CatalogNavHistory

All Implemented Interfaces:

ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging

public class CatalogNavHistory
extends NavHistory

A subclass of NavHistory that is to be used with the catalog or other hierarchical repository. This class overrides the method getDefaultHistory() from NavHistory which is used when we need to guess the Navigation History of a repository item. In the case of the DCS catalog, the repository is structured hierarchically and so the default history is the items parent category and the parent's parent and the parent's parent's parent and so forth until a root category is reached.

See Also:

NavHistory

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

CatalogNavHistory()

Method Summary

CatalogTools	getCatalogTools() Returns the property catalogTools which is a reference to a DCS component that takes care of many common catalog related tasks.
java.util.LinkedList	getDefaultHistory(java.lang.Object pItem) This method returns the list of ancestors of the given item.
void	setCatalogTools(CatalogTools pCatalogTools) Sets the property catalogTools which is a reference to a DCS component that takes care of many common catalog related tasks.

Methods inherited from class atg.repository.servlet.NavHistory

getNavCount, getNavHistory, incrementNavCount, navigate, resetHistory, setNavCount, setNavHistory, toString

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

addGlobalLogListeners, addLogListener, getLoggingForVlogging, getLoggingIdentifer, getLoggingIdentifier, getLogListenerCount, getLogListeners, initializeFromServiceEvent, isAutoInitListeners, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, removeLogListener, sendLogEvent, setAutoInitListeners, setLoggingDebug, setLoggingError, setLoggingIdentifier, 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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

CatalogNavHistory

public CatalogNavHistory()

Method Detail

setCatalogTools

public void setCatalogTools(CatalogTools pCatalogTools)

Sets the property catalogTools which is a reference to a DCS component that takes care of many common catalog related tasks.

Parameters:

pCatalogTools - the DCS component located at /atg/commerce/catalog/CatalogTools

getCatalogTools

public CatalogTools getCatalogTools()

Returns the property catalogTools which is a reference to a DCS component that takes care of many common catalog related tasks.

getDefaultHistory

public java.util.LinkedList getDefaultHistory(java.lang.Object pItem)

This method returns the list of ancestors of the given item. The object passed in must be of a category or product RepositoryItem. If the object is not a repository item this method just delegates to the getDefaultHistory method.

Overrides:

getDefaultHistory in class NavHistory

Parameters:

pItem - a category or product RepositoryItem for which we would like to determine the default history.

Returns:

A list of category items or possibly an empty or null list if an error occurs.