atg.svc.self.ui
Class SelfServiceUIConfiguration

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

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

public class SelfServiceUIConfiguration
extends CommonUIConfiguration

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

Version:

$Id: //application/service/version/2007.3/SelfService/src/classes/atg/svc/self/ui/SelfServiceUIConfiguration.java#2 $$Change: 632007 $

Author:

Nitin Khare

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

SelfServiceUIConfiguration()

Method Summary

java.lang.String	getAdvisorCompanyID()
java.lang.String	getAdvisorPath()
java.lang.String	getAdvisorServer()
java.lang.String	getAdvisorSiteName()
java.lang.String	getAdvisorTemplate()
int	getBestBetInitialCount()
java.lang.String	getBrandingContextRoot()
java.lang.String	getEmailTemplateStylesheet()
char[]	getFilterChar() Get the global filter characters to be applied to all field for which no filters is defined.
java.util.Map	getFilterCharOnField() Get the map conataining parameter name vs filter corresponding to that parameter
char[]	getFilterCharOnField(java.lang.String pFieldName) Get the filter characters corresponding to the provided field
java.lang.String[]	getFilteredParamNames() Get an array of all parameter names on which filtering need to be done.
int	getHotSolutionsInitialCount()
int	getMaxPasswordLength()
int	getMinPasswordLength()
int	getSearchExampleCount()
boolean	getShowPasswordRule()
java.lang.String	getSolutionEditorStylesheet()
int	getTopQuestionsInitialCount()
boolean	isEnableControlCharacterFilteringForSearchResultTitles() Get the value of mEnableControlCharacterFilteringForSearchResultTitles.
boolean	isLoginRequired() Overriding isLoginReuired() implementation to get the value based on the "AllowAnonymousUsers" global (site) option.
void	setAdvisorCompanyID(java.lang.String pAdvisorCompanyID)
void	setAdvisorPath(java.lang.String pAdvisorPath)
void	setAdvisorServer(java.lang.String pAdvisorServer)
void	setAdvisorSiteName(java.lang.String pAdvisorSiteName)
void	setAdvisorTemplate(java.lang.String pAdvisorTemplate)
void	setBestBetInitialCount(int pBestBetInitialCount)
void	setBrandingContextRoot(java.lang.String pBrandingContextRoot)
void	setEmailTemplateStylesheet(java.lang.String pEmailTemplateStylesheet)
void	setEnableControlCharacterFilteringForSearchResultTitles(boolean pEnableControlCharacterFilteringForSearchResultTitles) Set the value of EnableControlCharacterFilteringForSearchResultTitles.
void	setFilterChar(char[] pFilterChar) Set the global filter characters to be applied to all field for which no filters is defined.
void	setFilterCharOnField(java.util.Map pFilterCharOnField) Set the map conataining parameter name vs filter corresponding to that parameter
void	setFilteredParamNames(java.lang.String[] pFilteredParamNames) Set an array of all parameter names on which filtering need to be done.
void	setHotSolutionsInitialCount(int pHotSolutionsInitialCount)
void	setMaxPasswordLength(int pMaxPasswordLength)
void	setMinPasswordLength(int pMinPasswordLength)
void	setSearchExampleCount(int pSearchExampleCount)
void	setShowPasswordRule(boolean pShowPasswordRule)
void	setSolutionEditorStylesheet(java.lang.String pSolutionEditorStylesheet)
void	setTopQuestionsInitialCount(int pTopQuestionsInitialCount)

Methods inherited from class atg.svc.ui.CommonUIConfiguration

getAvailableResultLanguages, getAvailableSearchLanguages, getCommonUILocation, getContentStylesheet, getCssLocation, getDefaultAdvisorUrl, getEmailTemplatePaths, getExtensionsRoot, getImageLocation, getMainScript, getOuterStylesheet, getScriptsLocation, getSearchCluster, getStyleRoot, getSuggestedLoginParam, getSupportedOfferMgmtMediaMimeTypes, getTheme, getTipsStylesheet, getUseAdvisor, isEnableRequireLoginFilterForEmailTemplate, isSuggestedLoginEnabled, setAvailableResultLanguages, setAvailableSearchLanguages, setCommonUILocation, setContentStylesheet, setCssLocation, setDefaultAdvisorUrl, setEmailTemplatePaths, setEnableRequireLoginFilterForEmailTemplate, setExtensionsRoot, setImageLocation, setMainScript, setOuterStylesheet, setScriptsLocation, setSearchCluster, setStyleRoot, setSuggestedLoginEnabled, setSuggestedLoginParam, setSupportedOfferMgmtMediaMimeTypes, setTheme, setTipsStylesheet, setUseAdvisor

Methods inherited from class atg.web.UIConfiguration

getContextRoot, getLocaleSettingResourceBundle, getLoginURI, getLoginURISuccessParam, getMediaContextRoot, getNormalizeOutputXHTML, getRedirectDelayMS, getUserMessagesResourceBundle, 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 final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

SelfServiceUIConfiguration

public SelfServiceUIConfiguration()

Method Detail

getSearchExampleCount

public int getSearchExampleCount()

Returns:

Returns the searchExampleCount.

setSearchExampleCount

public void setSearchExampleCount(int pSearchExampleCount)

Parameters:

pSearchExampleCount - The searchExampleCount to set.

getBestBetInitialCount

public int getBestBetInitialCount()

setBestBetInitialCount

public void setBestBetInitialCount(int pBestBetInitialCount)

getTopQuestionsInitialCount

public int getTopQuestionsInitialCount()

setTopQuestionsInitialCount

public void setTopQuestionsInitialCount(int pTopQuestionsInitialCount)

getHotSolutionsInitialCount

public int getHotSolutionsInitialCount()

setHotSolutionsInitialCount

public void setHotSolutionsInitialCount(int pHotSolutionsInitialCount)

getSolutionEditorStylesheet

public java.lang.String getSolutionEditorStylesheet()

setSolutionEditorStylesheet

public void setSolutionEditorStylesheet(java.lang.String pSolutionEditorStylesheet)

getAdvisorServer

public java.lang.String getAdvisorServer()

setAdvisorServer

public void setAdvisorServer(java.lang.String pAdvisorServer)

getAdvisorPath

public java.lang.String getAdvisorPath()

setAdvisorPath

public void setAdvisorPath(java.lang.String pAdvisorPath)

getAdvisorSiteName

public java.lang.String getAdvisorSiteName()

setAdvisorSiteName

public void setAdvisorSiteName(java.lang.String pAdvisorSiteName)

getAdvisorCompanyID

public java.lang.String getAdvisorCompanyID()

setAdvisorCompanyID

public void setAdvisorCompanyID(java.lang.String pAdvisorCompanyID)

getAdvisorTemplate

public java.lang.String getAdvisorTemplate()

setAdvisorTemplate

public void setAdvisorTemplate(java.lang.String pAdvisorTemplate)

getEmailTemplateStylesheet

public java.lang.String getEmailTemplateStylesheet()

setEmailTemplateStylesheet

public void setEmailTemplateStylesheet(java.lang.String pEmailTemplateStylesheet)

getMinPasswordLength

public int getMinPasswordLength()

setMinPasswordLength

public void setMinPasswordLength(int pMinPasswordLength)

getMaxPasswordLength

public int getMaxPasswordLength()

setMaxPasswordLength

public void setMaxPasswordLength(int pMaxPasswordLength)

getShowPasswordRule

public boolean getShowPasswordRule()

setShowPasswordRule

public void setShowPasswordRule(boolean pShowPasswordRule)

isEnableControlCharacterFilteringForSearchResultTitles

public boolean isEnableControlCharacterFilteringForSearchResultTitles()

Get the value of mEnableControlCharacterFilteringForSearchResultTitles.

Returns:

value of mEnableControlCharacterFilteringForSearchResultTitles.

setEnableControlCharacterFilteringForSearchResultTitles

public void setEnableControlCharacterFilteringForSearchResultTitles(boolean pEnableControlCharacterFilteringForSearchResultTitles)

Set the value of EnableControlCharacterFilteringForSearchResultTitles.

Parameters:

paths - Value to assign to EnableControlCharacterFilteringForSearchResultTitles.

isLoginRequired

public boolean isLoginRequired()

Overriding isLoginReuired() implementation to get the value based on the "AllowAnonymousUsers" global (site) option.

Overrides:

isLoginRequired in class atg.web.UIConfiguration

getBrandingContextRoot

public java.lang.String getBrandingContextRoot()

setBrandingContextRoot

public void setBrandingContextRoot(java.lang.String pBrandingContextRoot)

getFilterChar

public char[] getFilterChar()

Get the global filter characters to be applied to all field for which no filters is defined. Includes following special characters: <, >, ", ', %, ;, (, ), &, +, -

setFilterChar

public void setFilterChar(char[] pFilterChar)

Set the global filter characters to be applied to all field for which no filters is defined. Includes following special characters: <, >, ", ', %, ;, (, ), &, +, -

getFilterCharOnField

public java.util.Map getFilterCharOnField()

Get the map conataining parameter name vs filter corresponding to that parameter

Returns:

setFilterCharOnField

public void setFilterCharOnField(java.util.Map pFilterCharOnField)

Set the map conataining parameter name vs filter corresponding to that parameter

getFilterCharOnField

public char[] getFilterCharOnField(java.lang.String pFieldName)

Get the filter characters corresponding to the provided field

Parameters:

pFieldName - The parameter name

Returns:

The filter characters corresponding to the provided field

getFilteredParamNames

public java.lang.String[] getFilteredParamNames()

Get an array of all parameter names on which filtering need to be done.

Returns:

setFilteredParamNames

public void setFilteredParamNames(java.lang.String[] pFilteredParamNames)

Set an array of all parameter names on which filtering need to be done.