public interface UserPreferences
Modifier and Type | Method and Description |
---|---|
java.util.Collection<java.lang.String> |
getAvailableDateFormats()
Get the collection of available date formats as
String . |
java.util.List<java.util.Locale> |
getAvailableDisplayLanguages()
Get the list of available display languages sorted by name.
|
java.util.List<java.util.Locale> |
getAvailableLocales()
Get the list of available locales sorted by name.
|
java.util.Collection<java.lang.String> |
getAvailableTimeFormats()
Get the collection of available time formats as
String . |
java.util.Collection<java.util.TimeZone> |
getAvailableTimezones()
Get the collection of available time zones.
|
java.util.Collection<NotificationOption> |
getNotificationSettings()
Return the notification settings of logged in user.
|
java.lang.String |
getPreferredDateFormat()
Get the preferred date format as
String . |
java.util.Locale |
getPreferredDisplayLanguage()
Get the preferred display language.
|
java.util.Locale |
getPreferredLocale()
Get the preferred locale.
|
java.lang.String |
getPreferredTimeFormat()
Get the preferred time format as
String . |
java.util.TimeZone |
getPreferredTimezone()
Get the preferred time zone.
|
boolean |
isMailMeEnabled()
Check if mailing the generated API key option is enabled or not.
|
boolean |
isNumberSeparatorEnabled()
Check if the number separator is enabled or disabled.
|
void |
setMailMeOption(boolean value)
Enable/disable the mail me generated API key option for current logged in user.
|
void |
setNotificationSettings(java.util.Collection<NotificationOption> notificationOptions)
Set the given notification settings to logged in user-specific configuration.
|
void |
setNumberSeparator(boolean isNumberSeparator)
Enable or disable the number separator.
|
void |
setPreferredDateFormat(java.lang.String preferredDateFormat)
Set the preferred date format as
String . |
void |
setPreferredDisplayLanguage(java.util.Locale prefDisplayLang)
Set the preferred display language.
|
void |
setPreferredLocale(java.util.Locale defaultLocale)
Set the preferred locale.
|
void |
setPreferredTimeFormat(java.lang.String preferredTimeFormat)
Set the preferred time format as
String . |
void |
setPreferredTimezone(java.util.TimeZone timeZone)
Set the preferred time zone as
String . |
java.util.Collection<NotificationOption> getNotificationSettings() throws CLLException
NotificationOption
CLLException
- If CLL fails to return the user's notification settingsvoid setNotificationSettings(java.util.Collection<NotificationOption> notificationOptions) throws CLLException
notificationOptions
- Collection of NotificationOption
(s) to be setCLLException
- If CLL fails to set the notification settings for userjava.util.Collection<java.lang.String> getAvailableDateFormats() throws CLLException
String
.CLLException
- If CLL fails to return the collection of available date formats for userjava.lang.String getPreferredDateFormat() throws CLLException
String
.CLLException
- If CLL fails to return the user's preferred date formatvoid setPreferredDateFormat(java.lang.String preferredDateFormat) throws CLLException
String
.preferredDateFormat
- Preferred date formatCLLException
- If CLL fails to set the preferred date format for userjava.util.Collection<java.lang.String> getAvailableTimeFormats() throws CLLException
String
.CLLException
- If CLL fails to return the collection of available time formats for userjava.lang.String getPreferredTimeFormat() throws CLLException
String
.CLLException
- If CLL fails to return the user's preferred time formatvoid setPreferredTimeFormat(java.lang.String preferredTimeFormat) throws CLLException
String
.preferredTimeFormat
- Preferred time formatCLLException
- If CLL fails to set the preferred time format for userjava.util.Collection<java.util.TimeZone> getAvailableTimezones() throws CLLException
CLLException
- If CLL fails to return the collection of available time zonesjava.util.TimeZone getPreferredTimezone() throws CLLException
CLLException
- If CLL fails to return the user's preferred time zonevoid setPreferredTimezone(java.util.TimeZone timeZone) throws CLLException
String
.timeZone
- Preferred time zoneCLLException
- If CLL fails to set the preferred time zone for userjava.util.List<java.util.Locale> getAvailableLocales() throws CLLException
Locale
s sorted by nameCLLException
- If CLL fails to return the list of available localesjava.util.Locale getPreferredLocale() throws CLLException
CLLException
- If CLL fails to return the user's preferred localevoid setPreferredLocale(java.util.Locale defaultLocale) throws CLLException
defaultLocale
- Preferred default localeCLLException
- If CLL fails to set the preferred default locale for userboolean isNumberSeparatorEnabled() throws CLLException
CLLException
- If CLL fails to check for the number separatorvoid setNumberSeparator(boolean isNumberSeparator) throws CLLException
isNumberSeparator
- If true, enables the number separatorCLLException
- If CLL fails to enable or disable the number separatorjava.util.List<java.util.Locale> getAvailableDisplayLanguages() throws CLLException
CLLException
- If CLL fails to return the list of available display languagesjava.util.Locale getPreferredDisplayLanguage() throws CLLException
CLLException
- If CLL fails to return the user's preferred display languagevoid setPreferredDisplayLanguage(java.util.Locale prefDisplayLang) throws CLLException
prefDisplayLang
- Preferred display languageCLLException
- If CLL fails to set the preferred display language for uservoid setMailMeOption(boolean value) throws CLLException
value
- boolean value true/falseCLLException
- If CLL fails to set the optionboolean isMailMeEnabled() throws CLLException
CLLException
- If CLL fails to check the option