Skip navigation links

waggle.common.modules.admin
Interface XAdminModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XAdminModule

public static interface XAdminModule.Server

extends XAPIInterface.Server

Server interface for the Admin Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	abortDisconnect(String message) Abort any disconnect.
List<XDateFormatInfo>	getDateFormats() Get all available date formats with localized labels inferred from the current user, request headers, or system default.
List<XLocaleInfo>	getLocales() Get all available locales with localized labels inferred from the current user, request headers, or system default.
List<XLocaleInfo>	getLocalesForLocale(String localeID) Get all available locales with localized labels in the specified locale.
List<XTimeZoneInfo>	getTimeZones() Get all available time zones with localized labels inferred from the current user, request headers, or system default.
List<XTimeZoneInfo>	getTimeZonesForLocale(String localeID) Get all available time zones with localized labels in the specified locale.
boolean	isDisconnectInProgress() Determine if any disconnect is in progress.
void	startDisconnect(String message, int minutes) Start a disconnect.

Method Detail

getLocales

List<XLocaleInfo> getLocales()

Get all available locales with localized labels inferred from the current user, request headers, or system default.

Returns:

All available locales. Sorted by label.

getLocalesForLocale

List<XLocaleInfo> getLocalesForLocale(String localeID)

Get all available locales with localized labels in the specified locale.

Parameters:

localeID - The locale for the returned labels (ex: "en_US" or "fr").

Returns:

All available locales. Sorted by label.

getTimeZones

List<XTimeZoneInfo> getTimeZones()

Get all available time zones with localized labels inferred from the current user, request headers, or system default.

Returns:

All available time zones. Sorted by id.

getTimeZonesForLocale

List<XTimeZoneInfo> getTimeZonesForLocale(String localeID)

Get all available time zones with localized labels in the specified locale.

Parameters:

localeID - The locale for the returned labels (ex: "en_US" or "fr").

Returns:

All available time zones. Sorted by id.

getDateFormats

List<XDateFormatInfo> getDateFormats()

Get all available date formats with localized labels inferred from the current user, request headers, or system default.

Returns:

All available date formats.

startDisconnect

void startDisconnect(String message,
                     int minutes)

Start a disconnect.

Parameters:

message - The message.

minutes - In how many minutes.

abortDisconnect

void abortDisconnect(String message)

Abort any disconnect.

Parameters:

message - The message.

isDisconnectInProgress

boolean isDisconnectInProgress()

Determine if any disconnect is in progress.

Returns:

True if any disconnect is in progress.

Skip navigation links