| org.sakaiproject.time.api.TimeService
All known Subclasses: org.sakaiproject.time.impl.BasicTimeService,
| TimeService | | public interface TimeService (Code) | |
TimeService ...
|
| Field Summary | |
| final static String | APPLICATION_ID
The type string for this "application": should not change over time as it may be stored in various parts of persistent entities. | | final public static String | TIMEZONE_KEY
|
| Method Summary | |
| boolean | clearLocalTimeZone(String userId)
| | boolean | different(Time a, Time b)
Compare two Time for differences, either may be null
Parameters:
a - One Time.
Parameters:
b - The other Time. | | GregorianCalendar | getCalendar(TimeZone zone, int year, int month, int day, int hour, int min, int sec, int ms)
Get a Calendar, set to this zone and these values.
Parameters:
zone - The TimeZone for the calendar.
Parameters:
year - full year (i.e. | | TimeZone | getLocalTimeZone()
Access the local TimeZone. | | Time | newTime()
Get a time object. | | Time | newTime(long value)
Get a time object, set from this long milliseconds since the "epoc" value.
Parameters:
value - time long milliseconds value. | | Time | newTime(GregorianCalendar cal)
| | TimeBreakdown | newTimeBreakdown(int year, int month, int day, int hour, int minute, int second, int millisecond)
Get a TimeBreakdown object, set from individual ints.
Parameters:
year - full year (i.e. | | Time | newTimeGmt(String value)
Get a time object, set from this string in our format, Gmt values
Parameters:
value - time format string. | | Time | newTimeGmt(int year, int month, int day, int hour, int minute, int second, int millisecond)
Get a time object, set from individual ints, Gmt values
Parameters:
year - full year (i.e. | | Time | newTimeGmt(TimeBreakdown breakdown)
Get a time object, set from this breakdown (Gmt values).
Parameters:
breakdown - The time breakdown values. | | Time | newTimeLocal(int year, int month, int day, int hour, int minute, int second, int millisecond)
Get a time object, set from individual ints, Local values
Parameters:
year - full year (i.e. | | Time | newTimeLocal(TimeBreakdown breakdown)
Get a time object, set from this breakdown (Local values).
Parameters:
breakdown - The time breakdown values. | | TimeRange | newTimeRange(Time start, Time end, boolean startIncluded, boolean endIncluded)
Get a TimeRange, from parts.
Parameters:
start - The start Time.
Parameters:
end - The end Time.
Parameters:
startIncluded - true if start is part of the range, false if not.
Parameters:
endIncluded - true of end is part of the range, false if not. | | TimeRange | newTimeRange(String value)
Get a TimeRange, from our string format.
Parameters:
value - The TimeRange string. | | TimeRange | newTimeRange(Time startAndEnd)
Get a TimeRange, from a single time.
Parameters:
startAndEnd - The Time for the range. | | TimeRange | newTimeRange(long start, long duration)
Get a TimeRange, from a time value long start and duration
Parameters:
start - The long start time (milliseconds since).
Parameters:
duration - The long milliseconds duration. | | TimeRange | newTimeRange(Time start, Time end)
Get a TimeRange, from two times, inclusive.
Parameters:
start - The start time.
Parameters:
end - The end time. |
| APPLICATION_ID | | final static String APPLICATION_ID(Code) | | The type string for this "application": should not change over time as it may be stored in various parts of persistent entities.
|
| TIMEZONE_KEY | | final public static String TIMEZONE_KEY(Code) | | Preferences key for user's time zone
|
| clearLocalTimeZone | | boolean clearLocalTimeZone(String userId)(Code) | | Clear local time zone for specified user
true if successful |
| different | | boolean different(Time a, Time b)(Code) | | Compare two Time for differences, either may be null
Parameters:
a - One Time.
Parameters:
b - The other Time. true if the Times are different, false if they are the same. |
| getCalendar | | GregorianCalendar getCalendar(TimeZone zone, int year, int month, int day, int hour, int min, int sec, int ms)(Code) | | Get a Calendar, set to this zone and these values.
Parameters:
zone - The TimeZone for the calendar.
Parameters:
year - full year (i.e. 1999, 2000)
Parameters:
month - month in year (1..12)
Parameters:
day - day in month (1..31)
Parameters:
hour - hour in day (0..23)
Parameters:
min - minute in hour (0..59)
Parameters:
second - second in minute (0..59)
Parameters:
ms - millisecond in second (0..999) |
| getLocalTimeZone | | TimeZone getLocalTimeZone()(Code) | | Access the local TimeZone.
The local TimeZone. |
| newTime | | Time newTime()(Code) | | Get a time object.
A time object, set to now. |
| newTime | | Time newTime(long value)(Code) | | Get a time object, set from this long milliseconds since the "epoc" value.
Parameters:
value - time long milliseconds value. A time object. |
| newTimeBreakdown | | TimeBreakdown newTimeBreakdown(int year, int month, int day, int hour, int minute, int second, int millisecond)(Code) | | Get a TimeBreakdown object, set from individual ints.
Parameters:
year - full year (i.e. 1999, 2000)
Parameters:
month - month in year (1..12)
Parameters:
day - day in month (1..31)
Parameters:
hour - hour in day (0..23)
Parameters:
minuet - minute in hour (0..59)
Parameters:
second - second in minute (0..59)
Parameters:
millisecond - millisecond in second (0..999) A TimeBreakdown. |
| newTimeGmt | | Time newTimeGmt(String value)(Code) | | Get a time object, set from this string in our format, Gmt values
Parameters:
value - time format string. A time object. |
| newTimeGmt | | Time newTimeGmt(int year, int month, int day, int hour, int minute, int second, int millisecond)(Code) | | Get a time object, set from individual ints, Gmt values
Parameters:
year - full year (i.e. 1999, 2000)
Parameters:
month - month in year (1..12)
Parameters:
day - day in month (1..31)
Parameters:
hour - hour in day (0..23)
Parameters:
minuet - minute in hour (0..59)
Parameters:
second - second in minute (0..59)
Parameters:
millisecond - millisecond in second (0..999) A time object. |
| newTimeGmt | | Time newTimeGmt(TimeBreakdown breakdown)(Code) | | Get a time object, set from this breakdown (Gmt values).
Parameters:
breakdown - The time breakdown values. A time object. |
| newTimeLocal | | Time newTimeLocal(int year, int month, int day, int hour, int minute, int second, int millisecond)(Code) | | Get a time object, set from individual ints, Local values
Parameters:
year - full year (i.e. 1999, 2000)
Parameters:
month - month in year (1..12)
Parameters:
day - day in month (1..31)
Parameters:
hour - hour in day (0..23)
Parameters:
minuet - minute in hour (0..59)
Parameters:
second - second in minute (0..59)
Parameters:
millisecond - millisecond in second (0..999) A time object. |
| newTimeLocal | | Time newTimeLocal(TimeBreakdown breakdown)(Code) | | Get a time object, set from this breakdown (Local values).
Parameters:
breakdown - The time breakdown values. A time object. |
| newTimeRange | | TimeRange newTimeRange(Time start, Time end, boolean startIncluded, boolean endIncluded)(Code) | | Get a TimeRange, from parts.
Parameters:
start - The start Time.
Parameters:
end - The end Time.
Parameters:
startIncluded - true if start is part of the range, false if not.
Parameters:
endIncluded - true of end is part of the range, false if not. A TimeRange. |
| newTimeRange | | TimeRange newTimeRange(String value)(Code) | | Get a TimeRange, from our string format.
Parameters:
value - The TimeRange string. A TimeRange. |
| newTimeRange | | TimeRange newTimeRange(Time startAndEnd)(Code) | | Get a TimeRange, from a single time.
Parameters:
startAndEnd - The Time for the range. A TimeRange. |
| newTimeRange | | TimeRange newTimeRange(long start, long duration)(Code) | | Get a TimeRange, from a time value long start and duration
Parameters:
start - The long start time (milliseconds since).
Parameters:
duration - The long milliseconds duration. A TimeRange. |
| newTimeRange | | TimeRange newTimeRange(Time start, Time end)(Code) | | Get a TimeRange, from two times, inclusive.
Parameters:
start - The start time.
Parameters:
end - The end time. A TimeRange. |
|
|