ConfigurationAccessor (Cyclos 4.3.2 Scripting API Documentation)

```
public interface ConfigurationAccessor
```
Contains methods to access the configuration in an hierarchical way

Author:

luis

Method Summary

Methods
Modifier and Type	Method and Description
`AdminHelpContent`	`getAdminHelpContent()`
`ResultType`	`getAdsResultType()`
`java.lang.String`	`getApplicationDescription()`
`java.lang.String`	`getApplicationName()`
`java.lang.String`	`getApplicationUsername()`
`int`	`getAutocompleteResults()`
`java.lang.Integer`	`getBannerRotateSeconds()`
`<CC extends ChannelConfiguration> CC`	`getChannelConfiguration(Channel channel)`
`java.util.List<Channel>`	`getChannels()`
`java.lang.String`	`getCommunityMenuLabel()`
`Configuration`	`getConfiguration()`
`Configuration`	`getConfigurationFor(java.lang.String property)`
`java.lang.String`	`getCountry()`
`DateFormat`	`getDateFormat()`
`UserDataPrivacyConfiguration`	`getDefaultAddressPrivacy()`
`java.lang.String`	`getDefaultCity()`
`UserDataPrivacyConfiguration`	`getDefaultEmailPrivacy()`
`UserDataPrivacyConfiguration`	`getDefaultPhonePrivacy()`
`java.lang.String`	`getDefaultRegion()`
`java.util.Set<java.lang.String>`	`getDefinedProperties()`
`java.lang.String`	`getDescription()`
`DistanceUnit`	`getDistanceUnit()`
`java.lang.String`	`getEmailName()`
`java.util.Set<EmailValidation>`	`getEmailValidation()`
`FooterContent`	`getFooterContent()`
`java.lang.String`	`getFullUrl()`
`java.lang.Integer`	`getGivenVeryBadRefs()`
`GuestHomeContent`	`getGuestHomeContent()`
`MenuType`	`getGuestsMenuType()`
`Theme`	`getGuestsTheme()`
`HeaderContent`	`getHeaderContent()`
`java.lang.Integer`	`getInvalidUsernameAttempts()`
`int`	`getJpegQuality()`
`Language`	`getLanguage()`
`ListSeparator`	`getListSeparator()`
`java.util.Set<java.lang.String>`	`getLockedProperties()`
`LogConfiguration`	`getLogConfiguration()`
`java.lang.String`	`getLogDir()`
`LoggedUserHomeContent`	`getLoggedUserHomeContent()`
`LoginFooterContent`	`getLoginFooterContent()`
`LoginHeaderContent`	`getLoginHeaderContent()`
`java.lang.String`	`getLoginUrl()`
`java.lang.String`	`getLogoutUrl()`
`java.lang.String`	`getMarketplaceMenuLabel()`
`int`	`getMaxFilesPerLog()`
`Dimensions`	`getMaxImageDimensions()`
`java.lang.Integer`	`getMaxLeftBanners()`
`FileSize`	`getMaxLogFileSize()`
`Dimensions`	`getMaxMediumThumbDimensions()`
`FileSize`	`getMaxPngSize()`
`java.lang.Integer`	`getMaxResults()`
`java.lang.Integer`	`getMaxResultsOnMap()`
`java.lang.Integer`	`getMaxRightBanners()`
`Dimensions`	`getMaxSmallThumbDimensions()`
`FileSize`	`getMaxUploadSize()`
`MobileHelpContent`	`getMobileHelpContent()`
`MobilePosHelpContent`	`getMobilePosHelpContent()`
`Theme`	`getMobileTheme()`
`java.lang.String`	`getName()`
`NumberFormat`	`getNumberFormat()`
`java.util.Set<OptionalAddressFields>`	`getOptionalAddressFields()`
`OutboundSmsConfiguration`	`getOutboundSmsConfiguration()`
`Configuration`	`getParent()`
`java.util.List<PasswordType>`	`getPasswords()`
`java.util.List<UserGroup>`	`getPossibleInitialGroups()`
`java.lang.Integer`	`getReceivedVeryBadRefs()`
`java.lang.String`	`getRegexForUsername()`
`TimeInterval`	`getRemoteAddressBlockTime()`
`java.util.Set<OptionalAddressFields>`	`getRequiredAddressFields()`
`java.lang.String`	`getRootUrl()`
`SmtpConfiguration`	`getSmtpConfiguration()`
`TimeFormat`	`getTimeFormat()`
`java.util.TimeZone`	`getTimeZone()`
`java.lang.String`	`getTimeZoneId()`
`java.util.Set<UserCustomField>`	`getUserCustomFieldsVisibleToGuests()`
`UserDisplay`	`getUserDisplay()`
`UserHelpContent`	`getUserHelpContent()`
`IntegerRange`	`getUsernameLength()`
`MenuType`	`getUsersMenuType()`
`ResultType`	`getUsersResultType()`
`Theme`	`getUsersTheme()`
`java.util.List<BasicGroup>`	`getVisibleAdGroups()`
`java.util.List<BasicGroup>`	`getVisibleUserGroups()`
`boolean`	`isAllowForgotPassword()`
`boolean`	`isAllowViewUserAd()`
`boolean`	`isAllowViewUserWebShop()`
`boolean`	`isAlwaysShowInternationalPhoneNumber()`
`boolean`	`isEmailRequired()`
`boolean`	`isEmailUnique()`
`boolean`	`isEnableServicesLog()`
`boolean`	`isEnableTasksLog()`
`boolean`	`isForceAccessWithThisUrl()`
`boolean`	`isGeneratedUsername()`
`boolean`	`isLandLineEnableExtension()`
`boolean`	`isLandLineRequired()`
`boolean`	`isLogServicesForGuests()`
`boolean`	`isLogServicesParameters()`
`boolean`	`isLogServicesResults()`
`boolean`	`isLogServicesWritesOnly()`
`boolean`	`isMobileRequired()`
`boolean`	`isMobileRequireSmsConfirmation()`
`boolean`	`isRequiredAddress()`
`boolean`	`isShowForgotPassword()`
`boolean`	`isUseLeftSpaceForGuests()`
`boolean`	`isUseMap()`

Method Detail

getAdminHelpContent
```
AdminHelpContent getAdminHelpContent()
```

getAdsResultType
```
ResultType getAdsResultType()
```

getApplicationDescription

java.lang.String getApplicationDescription()

getApplicationName
```
java.lang.String getApplicationName()
```

getApplicationUsername

java.lang.String getApplicationUsername()

getAutocompleteResults
```
int getAutocompleteResults()
```

getBannerRotateSeconds

java.lang.Integer getBannerRotateSeconds()

getChannelConfiguration

<CC extends ChannelConfiguration> CC getChannelConfiguration(Channel channel)

getChannels
```
java.util.List<Channel> getChannels()
```

getCommunityMenuLabel

java.lang.String getCommunityMenuLabel()

getConfiguration
```
Configuration getConfiguration()
```

getConfigurationFor
```
Configuration getConfigurationFor(java.lang.String property)
```
Returns:
the configuration in which is defined the specified property.

getCountry
```
java.lang.String getCountry()
```

getDateFormat
```
DateFormat getDateFormat()
```

getDefaultAddressPrivacy

UserDataPrivacyConfiguration getDefaultAddressPrivacy()

getDefaultCity
```
java.lang.String getDefaultCity()
```

getDefaultEmailPrivacy

UserDataPrivacyConfiguration getDefaultEmailPrivacy()

getDefaultPhonePrivacy

UserDataPrivacyConfiguration getDefaultPhonePrivacy()

getDefaultRegion
```
java.lang.String getDefaultRegion()
```

getDefinedProperties

java.util.Set<java.lang.String> getDefinedProperties()

getDescription
```
java.lang.String getDescription()
```

getDistanceUnit
```
DistanceUnit getDistanceUnit()
```

getEmailName
```
java.lang.String getEmailName()
```

getEmailValidation

java.util.Set<EmailValidation> getEmailValidation()

getFooterContent
```
FooterContent getFooterContent()
```

getFullUrl
```
java.lang.String getFullUrl()
```

getGivenVeryBadRefs

java.lang.Integer getGivenVeryBadRefs()

getGuestHomeContent
```
GuestHomeContent getGuestHomeContent()
```

getGuestsMenuType
```
MenuType getGuestsMenuType()
```

getGuestsTheme
```
Theme getGuestsTheme()
```

getHeaderContent
```
HeaderContent getHeaderContent()
```

getInvalidUsernameAttempts

java.lang.Integer getInvalidUsernameAttempts()

getJpegQuality
```
int getJpegQuality()
```

getLanguage
```
Language getLanguage()
```

getListSeparator
```
ListSeparator getListSeparator()
```

getLockedProperties

java.util.Set<java.lang.String> getLockedProperties()

getLogConfiguration
```
LogConfiguration getLogConfiguration()
```

getLogDir
```
java.lang.String getLogDir()
```

getLoggedUserHomeContent

LoggedUserHomeContent getLoggedUserHomeContent()

getLoginFooterContent

LoginFooterContent getLoginFooterContent()

getLoginHeaderContent

LoginHeaderContent getLoginHeaderContent()

getLoginUrl
```
java.lang.String getLoginUrl()
```

getLogoutUrl
```
java.lang.String getLogoutUrl()
```

getMarketplaceMenuLabel

java.lang.String getMarketplaceMenuLabel()

getMaxFilesPerLog
```
int getMaxFilesPerLog()
```

getMaxImageDimensions
```
Dimensions getMaxImageDimensions()
```

getMaxLeftBanners
```
java.lang.Integer getMaxLeftBanners()
```

getMaxLogFileSize
```
FileSize getMaxLogFileSize()
```

getMaxMediumThumbDimensions

Dimensions getMaxMediumThumbDimensions()

getMaxPngSize
```
FileSize getMaxPngSize()
```

getMaxResults
```
java.lang.Integer getMaxResults()
```

getMaxResultsOnMap
```
java.lang.Integer getMaxResultsOnMap()
```

getMaxRightBanners
```
java.lang.Integer getMaxRightBanners()
```

getMaxSmallThumbDimensions

Dimensions getMaxSmallThumbDimensions()

getMaxUploadSize
```
FileSize getMaxUploadSize()
```

getMobileHelpContent

MobileHelpContent getMobileHelpContent()

getMobilePosHelpContent

MobilePosHelpContent getMobilePosHelpContent()

getMobileTheme
```
Theme getMobileTheme()
```

getName
```
java.lang.String getName()
```

getNumberFormat
```
NumberFormat getNumberFormat()
```

getOptionalAddressFields

java.util.Set<OptionalAddressFields> getOptionalAddressFields()

getOutboundSmsConfiguration

OutboundSmsConfiguration getOutboundSmsConfiguration()

getParent
```
Configuration getParent()
```

getPasswords

java.util.List<PasswordType> getPasswords()

getPossibleInitialGroups

java.util.List<UserGroup> getPossibleInitialGroups()

getReceivedVeryBadRefs

java.lang.Integer getReceivedVeryBadRefs()

getRegexForUsername
```
java.lang.String getRegexForUsername()
```

getRemoteAddressBlockTime

TimeInterval getRemoteAddressBlockTime()

getRequiredAddressFields

java.util.Set<OptionalAddressFields> getRequiredAddressFields()

getRootUrl
```
java.lang.String getRootUrl()
```

getSmtpConfiguration

SmtpConfiguration getSmtpConfiguration()

getTimeFormat
```
TimeFormat getTimeFormat()
```

getTimeZone
```
java.util.TimeZone getTimeZone()
```

getTimeZoneId
```
java.lang.String getTimeZoneId()
```

getUserCustomFieldsVisibleToGuests

java.util.Set<UserCustomField> getUserCustomFieldsVisibleToGuests()

getUserDisplay
```
UserDisplay getUserDisplay()
```

getUserHelpContent
```
UserHelpContent getUserHelpContent()
```

getUsernameLength
```
IntegerRange getUsernameLength()
```

getUsersMenuType
```
MenuType getUsersMenuType()
```

getUsersResultType
```
ResultType getUsersResultType()
```

getUsersTheme
```
Theme getUsersTheme()
```

getVisibleAdGroups

java.util.List<BasicGroup> getVisibleAdGroups()

getVisibleUserGroups

java.util.List<BasicGroup> getVisibleUserGroups()

isAllowForgotPassword
```
boolean isAllowForgotPassword()
```

isAllowViewUserAd
```
boolean isAllowViewUserAd()
```

isAllowViewUserWebShop
```
boolean isAllowViewUserWebShop()
```

isAlwaysShowInternationalPhoneNumber

boolean isAlwaysShowInternationalPhoneNumber()

isEmailRequired
```
boolean isEmailRequired()
```

isEmailUnique
```
boolean isEmailUnique()
```

isEnableServicesLog
```
boolean isEnableServicesLog()
```

isEnableTasksLog
```
boolean isEnableTasksLog()
```

isForceAccessWithThisUrl
```
boolean isForceAccessWithThisUrl()
```

isGeneratedUsername
```
boolean isGeneratedUsername()
```

isLandLineEnableExtension
```
boolean isLandLineEnableExtension()
```

isLandLineRequired
```
boolean isLandLineRequired()
```

isLogServicesForGuests
```
boolean isLogServicesForGuests()
```

isLogServicesParameters
```
boolean isLogServicesParameters()
```

isLogServicesResults
```
boolean isLogServicesResults()
```

isLogServicesWritesOnly
```
boolean isLogServicesWritesOnly()
```

isMobileRequired
```
boolean isMobileRequired()
```

isMobileRequireSmsConfirmation

boolean isMobileRequireSmsConfirmation()

isRequiredAddress
```
boolean isRequiredAddress()
```

isShowForgotPassword
```
boolean isShowForgotPassword()
```

isUseLeftSpaceForGuests
```
boolean isUseLeftSpaceForGuests()
```

isUseMap
```
boolean isUseMap()
```

Interface ConfigurationAccessor

Method Summary

Method Detail

getAdminHelpContent

getAdsResultType

getApplicationDescription

getApplicationName

getApplicationUsername

getAutocompleteResults

getBannerRotateSeconds

getChannelConfiguration

getChannels

getCommunityMenuLabel

getConfiguration

getConfigurationFor

getCountry

getDateFormat

getDefaultAddressPrivacy

getDefaultCity

getDefaultEmailPrivacy

getDefaultPhonePrivacy

getDefaultRegion

getDefinedProperties

getDescription

getDistanceUnit

getEmailName

getEmailValidation

getFooterContent

getFullUrl

getGivenVeryBadRefs

getGuestHomeContent

getGuestsMenuType

getGuestsTheme

getHeaderContent

getInvalidUsernameAttempts

getJpegQuality

getLanguage

getListSeparator

getLockedProperties

getLogConfiguration

getLogDir

getLoggedUserHomeContent

getLoginFooterContent

getLoginHeaderContent

getLoginUrl

getLogoutUrl

getMarketplaceMenuLabel

getMaxFilesPerLog

getMaxImageDimensions

getMaxLeftBanners

getMaxLogFileSize

getMaxMediumThumbDimensions

getMaxPngSize

getMaxResults

getMaxResultsOnMap

getMaxRightBanners

getMaxSmallThumbDimensions

getMaxUploadSize

getMobileHelpContent

getMobilePosHelpContent

getMobileTheme

getName

getNumberFormat

getOptionalAddressFields

getOutboundSmsConfiguration

getParent

getPasswords

getPossibleInitialGroups

getReceivedVeryBadRefs

getRegexForUsername

getRemoteAddressBlockTime

getRequiredAddressFields

getRootUrl

getSmtpConfiguration

getTimeFormat

getTimeZone

getTimeZoneId

getUserCustomFieldsVisibleToGuests

getUserDisplay

getUserHelpContent