com.appiancorp.suiteapi.portal

Interface GlobalizationService

All Superinterfaces:

ContextSensitiveSingletonService, Service

Deprecated.

Globalization updates should be done via the Admin Console.

@Deprecated
public interface GlobalizationService
extends ContextSensitiveSingletonService

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

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	getSiteCalendarSettings$UPDATES Deprecated.
static boolean	getSiteCalendarSettingsClone$UPDATES Deprecated.
static boolean	getSiteLocaleSettings$UPDATES Deprecated.
static boolean	getSiteLocaleSettingsClone$UPDATES Deprecated.
static boolean	getSiteTimeZoneSettings$UPDATES Deprecated.
static boolean	getSiteTimeZoneSettingsClone$UPDATES Deprecated.
static boolean	setSiteCalendarSettings$UPDATES Deprecated.
static boolean	setSiteLocaleSettings$UPDATES Deprecated.
static boolean	setSiteTimeZoneSettings$UPDATES Deprecated.
static boolean	setTimeZone$UPDATES Deprecated.

Fields inherited from interface com.appiancorp.services.ContextSensitiveSingletonService

CONFIGURE_METHOD_NAME

Method Summary

Modifier and Type	Method and 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 timezoneSettings_) 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 Detail

getSiteLocaleSettings$UPDATES

static final boolean getSiteLocaleSettings$UPDATES

Deprecated.

See Also:

Constant Field Values

getSiteLocaleSettingsClone$UPDATES

static final boolean getSiteLocaleSettingsClone$UPDATES

Deprecated.

See Also:

Constant Field Values

setSiteLocaleSettings$UPDATES

static final boolean setSiteLocaleSettings$UPDATES

Deprecated.

See Also:

Constant Field Values

getSiteTimeZoneSettings$UPDATES

static final boolean getSiteTimeZoneSettings$UPDATES

Deprecated.

See Also:

Constant Field Values

getSiteTimeZoneSettingsClone$UPDATES

static final boolean getSiteTimeZoneSettingsClone$UPDATES

Deprecated.

See Also:

Constant Field Values

setSiteTimeZoneSettings$UPDATES

static final boolean setSiteTimeZoneSettings$UPDATES

Deprecated.

See Also:

Constant Field Values

setSiteCalendarSettings$UPDATES

static final boolean setSiteCalendarSettings$UPDATES

Deprecated.

See Also:

Constant Field Values

getSiteCalendarSettings$UPDATES

static final boolean getSiteCalendarSettings$UPDATES

Deprecated.

See Also:

Constant Field Values

getSiteCalendarSettingsClone$UPDATES

static final boolean getSiteCalendarSettingsClone$UPDATES

Deprecated.

See Also:

Constant Field Values

setTimeZone$UPDATES

static final boolean setTimeZone$UPDATES

Deprecated.

See Also:

Constant Field Values

Method Detail

getSiteLocaleSettings

@Deprecated
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

SiteLocaleSettings getSiteLocaleSettingsClone()

Deprecated.

Gets the site locale settings for the site.

Returns:

A copy of the site locale settings.

setSiteLocaleSettings

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
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

SiteTimeZoneSettings getSiteTimeZoneSettingsClone()

Deprecated.

Gets the site timezone settings for the site.

Returns:

A copy of the site timezone settings.

setSiteTimeZoneSettings

void setSiteTimeZoneSettings(SiteTimeZoneSettings timezoneSettings_)

Deprecated.

Registers the site timezone settings for the entire site.

Parameters:

settings_ - New timezone settings for the entire site.

setSiteCalendarSettings

void setSiteCalendarSettings(SiteCalendarSettings settings_)

Deprecated.

Sets the Calendar specific setting for the site.

Parameters:

settings_ - new calendar settings for the site CalendarSetting

getSiteCalendarSettings

@Deprecated
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

SiteCalendarSettings getSiteCalendarSettingsClone()

Deprecated.

Gets the calendar specific settings for the site

Returns:

A copy of the site calendar settings. CalendarSetting

setTimeZone

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