atg.svc.ui
Class CommonUIConfiguration

java.lang.Object
  atg.nucleus.GenericService
      atg.web.UIConfiguration
          atg.svc.ui.CommonUIConfiguration

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

Direct Known Subclasses:

SelfServiceUIConfiguration

public class CommonUIConfiguration
extends atg.web.UIConfiguration

This class is a nucleus component for defining generic UI configuration properties such as the context root

Version:

$Id: //application/service/version/2007.3/common-ui/src/classes/atg/svc/ui/CommonUIConfiguration.java#2 $

Author:

William Wechtenhiser

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.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

CommonUIConfiguration()

Method Summary

java.lang.String	getAvailableResultLanguages()
java.lang.String	getAvailableSearchLanguages()
java.lang.String	getCommonUILocation()
java.lang.String	getContentStylesheet()
java.lang.String	getCssLocation()
java.lang.String	getDefaultAdvisorUrl()
java.lang.String[]	getEmailTemplatePaths() Get the value of EmailTemplatePaths.
java.lang.String	getExtensionsRoot()
java.lang.String	getImageLocation()
java.lang.String	getMainScript()
java.lang.String	getOuterStylesheet()
java.lang.String	getScriptsLocation()
java.lang.String	getSearchCluster()
java.lang.String	getStyleRoot()
java.lang.String	getSuggestedLoginParam()
java.lang.String[]	getSupportedOfferMgmtMediaMimeTypes() Returns the supportedOfferMgmtMediaMimeTypes.
java.lang.String	getTheme()
java.lang.String	getTipsStylesheet()
boolean	getUseAdvisor()
boolean	isEnableRequireLoginFilterForEmailTemplate() Get the value of mEnableRequireLoginFilterForEmailTemplate.
boolean	isSuggestedLoginEnabled()
void	setAvailableResultLanguages(java.lang.String pAvailableResultLanguages)
void	setAvailableSearchLanguages(java.lang.String pAvailableSearchLanguages)
void	setCommonUILocation(java.lang.String pCommonUILocation)
void	setContentStylesheet(java.lang.String pContentStylesheet)
void	setCssLocation(java.lang.String pCssLocation)
void	setDefaultAdvisorUrl(java.lang.String pDefaultAdvisorUrl)
void	setEmailTemplatePaths(java.lang.String[] paths) Set the value of EmailTemplatePaths.
void	setEnableRequireLoginFilterForEmailTemplate(boolean pEnableRequireLoginFilterForEmailTemplate) Set the value of EnableRequireLoginFilterForEmailTemplate.
void	setExtensionsRoot(java.lang.String root)
void	setImageLocation(java.lang.String pImageLocation)
void	setMainScript(java.lang.String pMainScript)
void	setOuterStylesheet(java.lang.String pOuterStylesheet)
void	setScriptsLocation(java.lang.String pScriptsLocation)
void	setSearchCluster(java.lang.String pSearchCluster)
void	setStyleRoot(java.lang.String pStyleRoot)
void	setSuggestedLoginEnabled(boolean pSuggestedLoginEnabled)
void	setSuggestedLoginParam(java.lang.String pSuggestedLoginParam)
void	setSupportedOfferMgmtMediaMimeTypes(java.lang.String[] pSupportedOfferMgmtMediaMimeTypes) Sets the supportedOfferMgmtMediaMimeTypes.
void	setTheme(java.lang.String pTheme)
void	setTipsStylesheet(java.lang.String pTipsStylesheet)
void	setUseAdvisor(boolean pUseAdvisor)

Methods inherited from class atg.web.UIConfiguration

getContextRoot, getLocaleSettingResourceBundle, getLoginURI, getLoginURISuccessParam, getMediaContextRoot, getNormalizeOutputXHTML, getRedirectDelayMS, getUserMessagesResourceBundle, isLoginRequired, setContextRoot, setLocaleSettingResourceBundle, setLoginRequired, setLoginURI, setLoginURISuccessParam, setMediaContextRoot, setNormalizeOutputXHTML, setRedirectDelayMS, setUserMessagesResourceBundle

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingWarning, setServiceInfo, startService, stopService

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

CommonUIConfiguration

public CommonUIConfiguration()

Method Detail

getSearchCluster

public java.lang.String getSearchCluster()

Returns:

Returns the SearchCluster.

setSearchCluster

public void setSearchCluster(java.lang.String pSearchCluster)

Parameters:

pSearchCluster - The SearchCluster to set.

getStyleRoot

public java.lang.String getStyleRoot()

Returns:

Returns the styleRoot.

setStyleRoot

public void setStyleRoot(java.lang.String pStyleRoot)

Parameters:

pStyleRoot - The styleRoot to set.

getCssLocation

public java.lang.String getCssLocation()

Returns:

Returns the cssLocation.

setCssLocation

public void setCssLocation(java.lang.String pCssLocation)

Parameters:

pCssLocation - The cssLocation to set.

getTheme

public java.lang.String getTheme()

Returns:

Returns the theme.

setTheme

public void setTheme(java.lang.String pTheme)

Parameters:

pTheme - The theme to set.

getContentStylesheet

public java.lang.String getContentStylesheet()

Returns:

Returns the contentStylesheet.

setContentStylesheet

public void setContentStylesheet(java.lang.String pContentStylesheet)

Parameters:

pContentStylesheet - The contentStylesheet to set.

getOuterStylesheet

public java.lang.String getOuterStylesheet()

Returns:

Returns the outerStylesheet.

setOuterStylesheet

public void setOuterStylesheet(java.lang.String pOuterStylesheet)

Parameters:

pOuterStylesheet - The outerStylesheet to set.

getTipsStylesheet

public java.lang.String getTipsStylesheet()

Returns:

Returns the tipsStylesheet.

setTipsStylesheet

public void setTipsStylesheet(java.lang.String pTipsStylesheet)

Parameters:

pTipsStylesheet - The tipsStylesheet to set.

getScriptsLocation

public java.lang.String getScriptsLocation()

Returns:

Returns the scriptsLocation.

setScriptsLocation

public void setScriptsLocation(java.lang.String pScriptsLocation)

Parameters:

pScriptsLocation - The scriptsLocation to set.

getMainScript

public java.lang.String getMainScript()

Returns:

Returns the mainScript.

setMainScript

public void setMainScript(java.lang.String pMainScript)

Parameters:

pMainScript - The mainScript to set.

getImageLocation

public java.lang.String getImageLocation()

Returns:

Returns the imageLocation.

setImageLocation

public void setImageLocation(java.lang.String pImageLocation)

Parameters:

pImageLocation - The imageLocation to set.

getCommonUILocation

public java.lang.String getCommonUILocation()

Returns:

Returns the commonUILocation.

setCommonUILocation

public void setCommonUILocation(java.lang.String pCommonUILocation)

Parameters:

pCommonUILocation - The commonUILocation to set.

isSuggestedLoginEnabled

public boolean isSuggestedLoginEnabled()

Returns:

Returns the suggestedLoginEnabled

setSuggestedLoginEnabled

public void setSuggestedLoginEnabled(boolean pSuggestedLoginEnabled)

Parameters:

pSuggestedLoginEnabled - The suggestedLoginEnabled to set.

getSuggestedLoginParam

public java.lang.String getSuggestedLoginParam()

Returns:

Returns the suggestedLoginParam.

setSuggestedLoginParam

public void setSuggestedLoginParam(java.lang.String pSuggestedLoginParam)

Parameters:

pSuggestedLoginParam - The suggestedLoginParam to set.

getAvailableSearchLanguages

public java.lang.String getAvailableSearchLanguages()

Returns:

Returns the AvailableSearchLanguages.

setAvailableSearchLanguages

public void setAvailableSearchLanguages(java.lang.String pAvailableSearchLanguages)

Parameters:

pSearchLanguages - A delimited list of Available Supported Search Languages.

getAvailableResultLanguages

public java.lang.String getAvailableResultLanguages()

Returns:

Returns the AvailableResultLanguages.

setAvailableResultLanguages

public void setAvailableResultLanguages(java.lang.String pAvailableResultLanguages)

Parameters:

pAvailableSearchLanguages - A delimited list of Available Supported Search Languages.

getUseAdvisor

public boolean getUseAdvisor()

Returns:

Returns the useAdvisor.

setUseAdvisor

public void setUseAdvisor(boolean pUseAdvisor)

Parameters:

pUseAdvisor - The useAdvisor to set.

getDefaultAdvisorUrl

public java.lang.String getDefaultAdvisorUrl()

Returns:

Returns the defaultAdvisorUrl.

setDefaultAdvisorUrl

public void setDefaultAdvisorUrl(java.lang.String pDefaultAdvisorUrl)

Parameters:

pDefaultAdvisorUrl - The defaultAdvisorUrl to set.

getEmailTemplatePaths

public java.lang.String[] getEmailTemplatePaths()

Get the value of EmailTemplatePaths.

Returns:

value of EmailTemplatePaths.

setEmailTemplatePaths

public void setEmailTemplatePaths(java.lang.String[] paths)

Set the value of EmailTemplatePaths.

Parameters:

paths - Value to assign to EmailTemplatePaths.

isEnableRequireLoginFilterForEmailTemplate

public boolean isEnableRequireLoginFilterForEmailTemplate()

Get the value of mEnableRequireLoginFilterForEmailTemplate.

Returns:

value of mEnableRequireLoginFilterForEmailTemplate.

setEnableRequireLoginFilterForEmailTemplate

public void setEnableRequireLoginFilterForEmailTemplate(boolean pEnableRequireLoginFilterForEmailTemplate)

Set the value of EnableRequireLoginFilterForEmailTemplate.

Parameters:

paths - Value to assign to EnableRequireLoginFilterForEmailTemplate.

setExtensionsRoot

public void setExtensionsRoot(java.lang.String root)

getExtensionsRoot

public java.lang.String getExtensionsRoot()

getSupportedOfferMgmtMediaMimeTypes

public java.lang.String[] getSupportedOfferMgmtMediaMimeTypes()

Returns the supportedOfferMgmtMediaMimeTypes.

Returns:

supportedOfferMgmtMediaMimeTypes

setSupportedOfferMgmtMediaMimeTypes

public void setSupportedOfferMgmtMediaMimeTypes(java.lang.String[] pSupportedOfferMgmtMediaMimeTypes)

Sets the supportedOfferMgmtMediaMimeTypes.

Parameters:

pSupportedOfferMgmtMediaMimeTypes -