Package org.silverpeas.core.reminder

Class ReminderSettings

java.lang.Object

org.silverpeas.core.reminder.ReminderSettings

public class ReminderSettings
extends Object

Author:

silveryocha

Field Summary

Fields

Modifier and Type	Field	Description
static String	MESSAGES_PATH	The relative path of the i18n bundle of the reminder component.
static String	SETTINGS_PATH	The relative path of the properties file containing the settings of the reminder services.

Method Summary

Modifier and Type	Method	Description
static org.apache.commons.lang3.tuple.Pair<Integer,TimeUnit>	getDefaultReminder()	Gets the default reminder to set.
static org.silverpeas.kernel.bundle.LocalizationBundle	getMessagesIn(String language)	Gets all the messages for the reminder services and translated in the specified language.
static Stream<org.apache.commons.lang3.tuple.Pair<Integer,TimeUnit>>	getPossibleReminders()	Gets the list of possible reminders.
static org.silverpeas.kernel.bundle.SettingBundle	getSettings()	Gets all the settings about reminder services.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SETTINGS_PATH

public static final String SETTINGS_PATH

The relative path of the properties file containing the settings of the reminder services.

See Also:

Constant Field Values

MESSAGES_PATH

public static final String MESSAGES_PATH

The relative path of the i18n bundle of the reminder component.

See Also:

Constant Field Values

Method Detail

getMessagesIn

public static org.silverpeas.kernel.bundle.LocalizationBundle getMessagesIn(String language)

Gets all the messages for the reminder services and translated in the specified language.

Parameters:

language - the language in which are written the messages.

Returns:

the resource with the translated messages.

getSettings

public static org.silverpeas.kernel.bundle.SettingBundle getSettings()

Gets all the settings about reminder services.

Returns:

the resource with the different service settings.

getPossibleReminders

public static Stream<org.apache.commons.lang3.tuple.Pair<Integer,TimeUnit>> getPossibleReminders()

Gets the list of possible reminders. Each reminder is represented by a Pair of duration and a time unit (precising the duration indeed).

Returns:

list of Pair

getDefaultReminder

public static org.apache.commons.lang3.tuple.Pair<Integer,TimeUnit> getDefaultReminder()

Gets the default reminder to set.

Returns:

a Pair representing the default reminder.