Package com.appiancorp.suiteapi.portal

Interface GlobalizationService

All Superinterfaces:

ContextSensitiveSingletonService, Service

@Deprecated
public interface GlobalizationService
extends ContextSensitiveSingletonService

Deprecated.

Globalization updates should be done via the Admin Console.

Defines methods for retrieving and configuring internationalization settings such as locale and timezone.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	getSiteCalendarSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getSiteCalendarSettingsClone$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getSiteLocaleSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getSiteLocaleSettingsClone$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getSiteTimeZoneSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getSiteTimeZoneSettingsClone$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setSiteCalendarSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setSiteLocaleSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setSiteTimeZoneSettings$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	setTimeZone$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from interface com.appiancorp.services.ContextSensitiveSingletonService

CONFIGURE_METHOD_NAME

Method Summary

Modifier and Type	Method	Description
SiteCalendarSettings	getSiteCalendarSettings()	Deprecated. Retrieval of site calendar settings should be done via getSiteCalendarSettingsClone CalendarSetting
SiteCalendarSettings	getSiteCalendarSettingsClone()	Deprecated. Gets the calendar specific settings for the site
SiteLocaleSettings	getSiteLocaleSettings()	Deprecated. Retrieving site locale settings should be done via getSiteLocaleSettingsClone
SiteLocaleSettings	getSiteLocaleSettingsClone()	Deprecated. Gets the site locale settings for the site.
SiteTimeZoneSettings	getSiteTimeZoneSettings()	Deprecated. Retrieval of site timezone settings should be done via getSiteTimeZoneSettingsClone
SiteTimeZoneSettings	getSiteTimeZoneSettingsClone()	Deprecated. Gets the site timezone settings for the site.
void	setSiteCalendarSettings(SiteCalendarSettings settings_)	Deprecated. Sets the Calendar specific setting for the site.
void	setSiteLocaleSettings(SiteLocaleSettings localeSettings_)	Deprecated. Registers the site local settings for the entire site.
void	setSiteTimeZoneSettings(SiteTimeZoneSettings settings_)	Deprecated. Registers the site timezone settings for the entire site.
void	setTimeZone(BackendTimeZoneSimple tz)	Deprecated. Set the time zone information using the format used by the engines to encapsulate time zone information.

Methods inherited from interface com.appiancorp.services.ContextSensitiveSingletonService

configureContextSensitiveSingletonService

Field Details

getSiteLocaleSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean getSiteLocaleSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getSiteLocaleSettingsClone$UPDATES

@Deprecated(forRemoval=true)
static final boolean getSiteLocaleSettingsClone$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setSiteLocaleSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean setSiteLocaleSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getSiteTimeZoneSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean getSiteTimeZoneSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getSiteTimeZoneSettingsClone$UPDATES

@Deprecated(forRemoval=true)
static final boolean getSiteTimeZoneSettingsClone$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setSiteTimeZoneSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean setSiteTimeZoneSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setSiteCalendarSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean setSiteCalendarSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getSiteCalendarSettings$UPDATES

@Deprecated(forRemoval=true)
static final boolean getSiteCalendarSettings$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getSiteCalendarSettingsClone$UPDATES

@Deprecated(forRemoval=true)
static final boolean getSiteCalendarSettingsClone$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

setTimeZone$UPDATES

@Deprecated(forRemoval=true)
static final boolean setTimeZone$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

Method Details

getSiteLocaleSettings

@Deprecated
@Read(K_PORTAL)
SiteLocaleSettings getSiteLocaleSettings()

Deprecated.

Retrieving site locale settings should be done via getSiteLocaleSettingsClone

Gets the site locale settings for the site.

Returns:

The site locale settings of the site.

getSiteLocaleSettingsClone

@Read(K_PORTAL)
SiteLocaleSettings getSiteLocaleSettingsClone()

Deprecated.

Gets the site locale settings for the site.

Returns:

A copy of the site locale settings.

setSiteLocaleSettings

@Write({K_PORTAL,K_PERSONALIZATION,K_PROCESS_DESIGN,K_PROCESS_EXECUTION,K_PROCESS_ANALYTICS})
void setSiteLocaleSettings(SiteLocaleSettings localeSettings_)
                    throws PrivilegeException

Deprecated.

Registers the site local settings for the entire site. All the properties in the SiteLocaleSettings parameter must be populated. It is required that the primary locale defined in the parameter is present and enabled in the array of locale settings.

Parameters:

localeSettings_ - New locale settings for the entire site.

Throws:

PrivilegeException - if the current user is not a portal administrator

getSiteTimeZoneSettings

@Deprecated
@Read(K_PORTAL)
SiteTimeZoneSettings getSiteTimeZoneSettings()

Deprecated.

Retrieval of site timezone settings should be done via getSiteTimeZoneSettingsClone

Gets the site timezone settings for the site.

Returns:

The site timezone settings of the site.

getSiteTimeZoneSettingsClone

@Read(K_PORTAL)
SiteTimeZoneSettings getSiteTimeZoneSettingsClone()

Deprecated.

Gets the site timezone settings for the site.

Returns:

A copy of the site timezone settings.

setSiteTimeZoneSettings

@Write({K_PORTAL,K_PERSONALIZATION})
void setSiteTimeZoneSettings(SiteTimeZoneSettings settings_)

Deprecated.

Registers the site timezone settings for the entire site.

Parameters:

settings_ - New timezone settings for the entire site.

setSiteCalendarSettings

@Write({K_PORTAL,K_PERSONALIZATION,K_PROCESS_DESIGN,K_PROCESS_EXECUTION,K_PROCESS_ANALYTICS})
void setSiteCalendarSettings(SiteCalendarSettings settings_)

Deprecated.

Sets the Calendar specific setting for the site.

Parameters:

settings_ - new calendar settings for the site CalendarSetting

getSiteCalendarSettings

@Deprecated
@Read(K_PORTAL)
SiteCalendarSettings getSiteCalendarSettings()

Deprecated.

Retrieval of site calendar settings should be done via getSiteCalendarSettingsClone CalendarSetting

Gets the calendar specific settings for the site

Returns:

Calendar settings for the site

getSiteCalendarSettingsClone

@Read(K_PORTAL)
SiteCalendarSettings getSiteCalendarSettingsClone()

Deprecated.

Gets the calendar specific settings for the site

Returns:

A copy of the site calendar settings. CalendarSetting

setTimeZone

@Write({K_FORUMS,K_PROCESS_DESIGN,K_PROCESS_EXECUTION,K_PROCESS_ANALYTICS})
void setTimeZone(BackendTimeZoneSimple tz)

Deprecated.

Set the time zone information using the format used by the engines to encapsulate time zone information. The time zone information is initialized during the intial applicaiton startup and should not need to be set using this method or any other afterward. Consider your use case when calling this method.

Parameters:

tz - The specially formatted time zone object used by the engines