atg.svc.self.ui
Class SelfServiceUIConfiguration

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.web.UIConfiguration
              extended by atg.svc.ui.CommonUIConfiguration
                  extended by 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.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 SelfServiceUIConfiguration
extends CommonUIConfiguration

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


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
SelfServiceUIConfiguration()
           
 
Method Summary
 int getBestBetInitialCount()
           
 java.lang.String getBrandingContextRoot()
           
 java.lang.String getEmailTemplateStylesheet()
           
 int getMaxPasswordLength()
           
 int getMinPasswordLength()
           
 int getSearchExampleCount()
           
 boolean getShowPasswordRule()
           
 java.lang.String getSolutionEditorStylesheet()
           
 boolean isEnableControlCharacterFilteringForSearchResultTitles()
          Get the value of mEnableControlCharacterFilteringForSearchResultTitles.
 boolean isLoginRequired()
          Overriding isLoginReuired() implementation to get the value based on the "AllowAnonymousUsers" global (site) option.
 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 setMaxPasswordLength(int pMaxPasswordLength)
           
 void setMinPasswordLength(int pMinPasswordLength)
           
 void setSearchExampleCount(int pSearchExampleCount)
           
 void setShowPasswordRule(boolean pShowPasswordRule)
           
 void setSolutionEditorStylesheet(java.lang.String pSolutionEditorStylesheet)
           
 
Methods inherited from class atg.svc.ui.CommonUIConfiguration
getCommonUILocation, getContentStylesheet, getCssLocation, getEmailTemplatePaths, getExtensionsRoot, getImageLocation, getMainScript, getOuterStylesheet, getScriptsLocation, getSearchCluster, getStyleRoot, getSuggestedLoginParam, getSupportedOfferMgmtMediaMimeTypes, getTheme, getTipsStylesheet, isEnableRequireLoginFilterForEmailTemplate, isSuggestedLoginEnabled, setCommonUILocation, setContentStylesheet, setCssLocation, setEmailTemplatePaths, setEnableRequireLoginFilterForEmailTemplate, setExtensionsRoot, setImageLocation, setMainScript, setOuterStylesheet, setScriptsLocation, setSearchCluster, setStyleRoot, setSuggestedLoginEnabled, setSuggestedLoginParam, setSupportedOfferMgmtMediaMimeTypes, setTheme, setTipsStylesheet
 
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, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
 
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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 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)

getSolutionEditorStylesheet

public java.lang.String getSolutionEditorStylesheet()

setSolutionEditorStylesheet

public void setSolutionEditorStylesheet(java.lang.String pSolutionEditorStylesheet)

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)