atg.repository.search.testing
Class SearchTestingEnvironment

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.repository.search.testing.SearchTestingEnvironment

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 SearchTestingEnvironment
extends GenericService

This interface provide methods to gain information of the environment.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

SearchTestingEnvironment()

Method Summary

java.lang.String[]	getAvailableLocaleNames() Getter for availableLocaleNames property
java.util.List<java.util.Locale>	getAvailableLocales() Method to get the list of java Locale object that are valid indexes for this environment.
java.lang.String	getDisplayName() Gets the display name if set in the properties file
java.lang.String	getDisplayNameResourceKey() Gets the resouce key to find the display name
atg.core.i18n.MultiBundleFormatter	getFormatter() Gets the MultiBundleFormatter service to lookup resource strings
java.lang.String	getLocalisedDisplayName(java.util.Locale pLocale) Gets the display name for the environment as looked up by the bundle formatter and resource key If these are not specified in the properties file then the mDisplayName property string will be returned
java.lang.String	getSearchEnvironmentName() Gets the search environment name known to search routing
void	setAvailableLocaleNames(java.lang.String[] pAvailableLocaleNames) Setter for availableLocaleNames property
void	setDisplayName(java.lang.String pDisplayName) Sets the display name
void	setDisplayNameResourceKey(java.lang.String pDisplayNameResourceKey) Sets the display name resource key
void	setFormatter(atg.core.i18n.MultiBundleFormatter pFormatter) Sets the MultiBundleFormatter service to lookup resource strings
void	setSearchEnvironmentName(java.lang.String pSearchEnvironmentName) Sets the search environment name known to search routing

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

Constructor Detail

SearchTestingEnvironment

public SearchTestingEnvironment()

Method Detail

getFormatter

public atg.core.i18n.MultiBundleFormatter getFormatter()

Gets the MultiBundleFormatter service to lookup resource strings

Returns:

the MultiBundleFormatter

setFormatter

public void setFormatter(atg.core.i18n.MultiBundleFormatter pFormatter)

Sets the MultiBundleFormatter service to lookup resource strings

Parameters:

pSearchEnvironmentResourcePrefix - location of the resource key

getLocalisedDisplayName

public java.lang.String getLocalisedDisplayName(java.util.Locale pLocale)

Gets the display name for the environment as looked up by the bundle formatter and resource key If these are not specified in the properties file then the mDisplayName property string will be returned

Returns:

the LocalisedDisplayName

getSearchEnvironmentName

public java.lang.String getSearchEnvironmentName()

Gets the search environment name known to search routing

Returns:

the SearchEnvironmentName

setSearchEnvironmentName

public void setSearchEnvironmentName(java.lang.String pSearchEnvironmentName)

Sets the search environment name known to search routing

Parameters:

pSearchEnvironmentName -

getDisplayName

public java.lang.String getDisplayName()

Gets the display name if set in the properties file

Returns:

the mDisplayName

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)

Sets the display name

Parameters:

pDisplayName -

getDisplayNameResourceKey

public java.lang.String getDisplayNameResourceKey()

Gets the resouce key to find the display name

Returns:

mDisplayNameResouceKey

setDisplayNameResourceKey

public void setDisplayNameResourceKey(java.lang.String pDisplayNameResourceKey)

Sets the display name resource key

Parameters:

pDisplayNameResourceKey -

getAvailableLocaleNames

public java.lang.String[] getAvailableLocaleNames()

Getter for availableLocaleNames property

Returns:

Array of String available locale names

setAvailableLocaleNames

public void setAvailableLocaleNames(java.lang.String[] pAvailableLocaleNames)

Setter for availableLocaleNames property

Parameters:

pAvailableLocaleNames - Array of String available locale names

getAvailableLocales

public java.util.List<java.util.Locale> getAvailableLocales()

Method to get the list of java Locale object that are valid indexes for this environment. This method should return null if the global list defined in the search testing service should be used.

Returns:

List of Locale or null if none defined