atg.projects.store.recommendations
Class StoreRecommendationsConfiguration

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.projects.store.recommendations.StoreRecommendationsConfiguration
All Implemented Interfaces:
atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

public class StoreRecommendationsConfiguration
extends atg.nucleus.GenericService

The configuration of the store recommendations auto-tagging feature.

Version:
$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/Recommendations/src/atg/projects/store/recommendations/StoreRecommendationsConfiguration.java#2 $$Change: 788983 $
Author:
ATG

Field Summary
static java.lang.String CLASS_VERSION
           
 
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
StoreRecommendationsConfiguration()
           
 
Method Summary
 java.lang.String[] getCartChangeJMSTypes()
          Returns JMSTypes of events that indicate that cart content has been changed.
 java.lang.String getCatalogNavHistoryPath()
          Returns the path to catalog navigation history component.
 atg.commerce.pricing.priceLists.PriceListManager getPriceListManager()
          Returns the price list manager.
 java.lang.String getRecommendationsScriptUrl()
          Returns the URL to recommendations JavaScript library.
 java.lang.String getRetailerId()
          Returns recommendations account retailer ID.
 java.lang.String[] getSearchResultsPages()
          Returns the list of search results pages on which the searchTermQueryArgs should be looked for.
 atg.service.cache.Cache getSearchResultsPagesCache()
          Returns the cache storing whether URLs match SearchResultsPages patterns
 java.lang.String[] getSearchTermQueryArgs()
          Returns an array of query arguments that specify what search term is searched for.
 boolean isIncludeRootCategory()
          Returns the boolean indicating whether to include root category into the category path.
 void setCartChangeJMSTypes(java.lang.String[] pCartChangeJMSTypes)
          The JMSTypes of events that indicate that cart content has been changed.
 void setCatalogNavHistoryPath(java.lang.String pCatalogNavHistoryPath)
          Sets the path to catalog navigation history component.
 void setIncludeRootCategory(boolean pIncludeRootCategory)
          Sets the boolean indicating whether to include root category into the category path.
 void setPriceListManager(atg.commerce.pricing.priceLists.PriceListManager pPriceListManager)
          Sets the price list manager.
 void setRecommendationsScriptUrl(java.lang.String pRecommendationsScriptUrl)
          Sets the URL to recommendations JavaScript library.
 void setRetailerId(java.lang.String pRetailerId)
          Sets recommendations account retailer ID.
 void setSearchResultsPages(java.lang.String[] pSearchResultsPages)
          Sets the list of search results pages on which the searchTermQueryArgs should be looked for.
 void setSearchResultsPagesCache(atg.service.cache.Cache pSearchResultsPagesCache)
          Sets the cache storing whether URLs match SearchResultsPages patterns.
 void setSearchTermQueryArgs(java.lang.String[] pSearchTermQueryArgs)
          An array of query arguments that specify what search term is searched for.
 
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
Constructor Detail

StoreRecommendationsConfiguration

public StoreRecommendationsConfiguration()
Method Detail

getRetailerId

public java.lang.String getRetailerId()
Returns recommendations account retailer ID.

Returns:
the Recommendations Retailer ID

setRetailerId

public void setRetailerId(java.lang.String pRetailerId)
Sets recommendations account retailer ID.

Parameters:
RetailerId - the Recommendations Retailer ID to set

getRecommendationsScriptUrl

public java.lang.String getRecommendationsScriptUrl()
Returns the URL to recommendations JavaScript library.

Returns:
the Recommendation JavaScript library URL

setRecommendationsScriptUrl

public void setRecommendationsScriptUrl(java.lang.String pRecommendationsScriptUrl)
Sets the URL to recommendations JavaScript library.

Parameters:
pRecommendationsScriptUrl - - the Recommendation JavaScript library URL

setSearchTermQueryArgs

public void setSearchTermQueryArgs(java.lang.String[] pSearchTermQueryArgs)
An array of query arguments that specify what search term is searched for.

Parameters:
pSearchTermQueryArgs - An array of query arguments that specify what search term is searched for.

getSearchTermQueryArgs

public java.lang.String[] getSearchTermQueryArgs()
Returns an array of query arguments that specify what search term is searched for.

Returns:
An array of query arguments that specify what search term is searched for.

getSearchResultsPages

public java.lang.String[] getSearchResultsPages()
Returns the list of search results pages on which the searchTermQueryArgs should be looked for. Wildcard characters can be used. If this property is null, the searchTermQueryArgs are looked for on all pages.

Returns:
the String[] - the list of search results pages on which the searchTermQueryArgs should be looked for.

setSearchResultsPages

public void setSearchResultsPages(java.lang.String[] pSearchResultsPages)
Sets the list of search results pages on which the searchTermQueryArgs should be looked for. Wildcard characters can be used. If this property is null, the searchTermQueryArgs are looked for on all pages.

Parameters:
SearchResultsPages - the String[] - the list of search results pages on which the searchTermQueryArgs should be looked for.

getSearchResultsPagesCache

public atg.service.cache.Cache getSearchResultsPagesCache()
Returns the cache storing whether URLs match SearchResultsPages patterns

Returns:
The cache storing whether URLs match SearchResultsPages patterns

setSearchResultsPagesCache

public void setSearchResultsPagesCache(atg.service.cache.Cache pSearchResultsPagesCache)
Sets the cache storing whether URLs match SearchResultsPages patterns.

Parameters:
SearchResultsPagesCache - The cache storing whether URLs match SearchResultsPages patterns

setCartChangeJMSTypes

public void setCartChangeJMSTypes(java.lang.String[] pCartChangeJMSTypes)
The JMSTypes of events that indicate that cart content has been changed.

Parameters:
pCartChangeJMSTypes - The JMSTypes of events that indicate that cart content has been changed.

getCartChangeJMSTypes

public java.lang.String[] getCartChangeJMSTypes()
Returns JMSTypes of events that indicate that cart content has been changed.

Returns:
The JMSTypes of events that indicate that cart content has been changed.

getCatalogNavHistoryPath

public java.lang.String getCatalogNavHistoryPath()
Returns the path to catalog navigation history component.

Returns:
the catalogNavHistoryPath returns the path to catalog navigation history component.

setCatalogNavHistoryPath

public void setCatalogNavHistoryPath(java.lang.String pCatalogNavHistoryPath)
Sets the path to catalog navigation history component.

Parameters:
pCatalogNavHistoryPath - the path to catalog navigation history component.

getPriceListManager

public atg.commerce.pricing.priceLists.PriceListManager getPriceListManager()
Returns the price list manager.

Returns:
the priceListManager the price list manager.

setPriceListManager

public void setPriceListManager(atg.commerce.pricing.priceLists.PriceListManager pPriceListManager)
Sets the price list manager.

Parameters:
pPriceListManager - the price list manager.

isIncludeRootCategory

public boolean isIncludeRootCategory()
Returns the boolean indicating whether to include root category into the category path.

Returns:
the boolean indicating whether root category should be included into the category path

setIncludeRootCategory

public void setIncludeRootCategory(boolean pIncludeRootCategory)
Sets the boolean indicating whether to include root category into the category path.

Parameters:
pIncludeRootCategory - the boolean indicating whether root category should be included into the category path