public class TimeZoneSetting
extends oracle.webcenter.generalsettings.internal.model.GSPreferences
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_TIMEZONE_ID
The time zone used if the user does not set a time zone preference.
|
static java.lang.String |
TIME_ZONE_KEY
The internal preference key to store the time zone preference.
|
Constructor and Description |
---|
TimeZoneSetting() |
Modifier and Type | Method and Description |
---|---|
static java.util.Calendar |
getCurrentTime()
Get the current time as a Calendar object based on the current user's
timezone setting.
|
static java.util.Calendar |
getCurrentTime(java.lang.String username)
Gets the current time as a Calendar object based on the given user's
timezone setting.
|
static java.lang.String |
getDefaultTimeZone()
Returns the application's default time zone identifier.
|
static java.util.Calendar |
getGMTTime()
Returns a Calendar object representing the current time at the
Greenwich Meridian (time zone GMT+00:00).
|
static int |
getMidnightOffset()
Returns the number of minutes since midnight based on the current
user's timezone setting.
|
static int |
getMidnightOffset(java.lang.String username)
Returns the number of minutes since midnight based on the given
user's timezone setting.
|
static java.util.Calendar |
getMidnightToday()
Gets the Calendar object representing the midnight hour for the
current date irrespective of the current time.
|
static java.util.Calendar |
getMidnightToday(java.lang.String username)
Gets the Calendar object representing the midnight hour for the
current date irrespective of the current time.
|
static int |
getMidnightYesterdayOffset()
Returns the number of minutes since midnight of the previous night
based on the current user's timezone setting.
|
static int |
getMidnightYesterdayOffset(java.lang.String username)
Returns the number of minutes since midnight of the previous night
based on the given user's timezone setting.
|
static java.lang.String |
getPreferredTimeZone()
Returns the current user's preferred time zone identifier.
|
static java.lang.String |
getPreferredTimeZone(java.lang.String username)
Returns the given user's preferred time zone identifier.
|
static java.util.TimeZone |
getUserTimeZone()
Gets the current user's preferred time zone (as a TimeZone object).
|
static java.util.TimeZone |
getUserTimeZone(java.lang.String username)
Gets the given user's preferred time zone (as a TimeZone object).
|
static java.lang.String |
getUserTimeZonePref()
Returns the current user's time zone identifier preference value.
|
static java.lang.String |
getUserTimeZonePref(java.lang.String username)
Returns the given user's time zone identifier preference value.
|
static void |
setDefaultTimeZone(java.lang.String timezone)
Sets the application's time zone identifier.
|
static void |
setPreferredTimeZone(java.lang.String timezone)
Deprecated.
replaced by setUserTimeZonePref()
|
static void |
setPreferredTimeZone(java.lang.String username,
java.lang.String timezone)
Deprecated.
replaced by setUserTimeZonePref()
|
static void |
setUserTimeZone(java.lang.String username,
java.util.TimeZone timezone)
Sets the given user's preferred time zone (as a TimeZone object).
|
static void |
setUserTimeZone(java.util.TimeZone timezone)
Sets the current user's preferred time zone (as a TimeZone object).
|
static void |
setUserTimeZonePref(java.lang.String timezone)
Set the current user's preferred time zone identifier.
|
static void |
setUserTimeZonePref(java.lang.String username,
java.lang.String timezone)
Sets the given user's preferred time zone identifier.
|
public static final java.lang.String TIME_ZONE_KEY
public static java.lang.String DEFAULT_TIMEZONE_ID
public static java.lang.String getPreferredTimeZone()
The time zone identifier returned is in the format GMT{+|-}hh:mi,
for example, GMT+05:30 or GMT-08:00. This identifier enables you to create a
java.util.TimeZone
object as follows :-
TimeZone.getTimeZone("GMT+05:30");
public static java.lang.String getPreferredTimeZone(java.lang.String username)
The time zone identifier is returned in the format GMT{+|-}hh:mi,
for example, GMT+05:30 or GMT-08:00. This identifier can be used to create a
java.util.TimeZone
object as follows :-
TimeZone.getTimeZone("GMT+05:30");
username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userpublic static java.lang.String getUserTimeZonePref()
getPreferredTimeZone()
API should be used.
The time zone identifier is returned in the format GMT{+|-}hh:mi, for example, GMT+05:30 or GMT-08:00.
public static java.lang.String getUserTimeZonePref(java.lang.String username)
getPreferredTimeZone()
API should be used.
The time zone identifier is returned in the format GMT{+|-}hh:mi, for example, GMT+05:30 or GMT-08:00.
username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userpublic static void setPreferredTimeZone(java.lang.String username, java.lang.String timezone)
public static void setPreferredTimeZone(java.lang.String timezone)
public static void setUserTimeZonePref(java.lang.String timezone)
The time zone identifier should be of the format GMT{+|-}hh:mi e.g. GMT+05:30 or GMT-08:00.
timezone
- the preferred time zone identifierpublic static void setUserTimeZonePref(java.lang.String username, java.lang.String timezone)
The time zone identifier should be in the format GMT{+|-}hh:mi, for example, GMT+05:30 or GMT-08:00.
username
- the username to set the preference for. If null, sets
the preference for the current authenticated usertimezone
- the preferred time zone identifierpublic static java.lang.String getDefaultTimeZone()
The time zone identifier returned is in the format GMT{+|-}hh:mi,
for example, GMT+05:30 or GMT-08:00. This identifier enables you to create a
java.util.TimeZone
object as follows :-
TimeZone.getTimeZone("GMT+05:30");
public static void setDefaultTimeZone(java.lang.String timezone)
The time zone identifier should be in the format GMT{+|-}hh:mi, for example, GMT+05:30 or GMT-08:00.
timezone
- the preferred time zone identifierpublic static java.util.TimeZone getUserTimeZone()
public static java.util.TimeZone getUserTimeZone(java.lang.String username)
username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userpublic static void setUserTimeZone(java.util.TimeZone timezone)
timezone
- the time zone to setpublic static void setUserTimeZone(java.lang.String username, java.util.TimeZone timezone)
username
- the username to set the preference for. If null, sets
the preference for the current authenticated usertimezone
- the time zone to setpublic static java.util.Calendar getCurrentTime()
public static java.util.Calendar getCurrentTime(java.lang.String username)
username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userpublic static java.util.Calendar getMidnightToday()
public static java.util.Calendar getMidnightToday(java.lang.String username)
public static int getMidnightOffset()
public static int getMidnightOffset(java.lang.String username)
username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userpublic static int getMidnightYesterdayOffset()
public static int getMidnightYesterdayOffset(java.lang.String username)
username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userpublic static java.util.Calendar getGMTTime()