org.sakaiproject.time.api.TimeService Maven / Gradle / Ivy
The newest version!
/**********************************************************************************
* $URL$
* $Id$
***********************************************************************************
*
* Copyright (c) 2003, 2004, 2005, 2006, 2008 Sakai Foundation
*
* Licensed under the Educational Community License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.opensource.org/licenses/ECL-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
**********************************************************************************/
package org.sakaiproject.time.api;
import java.time.Instant;
import java.util.GregorianCalendar;
import java.util.TimeZone;
/**
*
* TimeService ...
*
* @deprecated Please use {@link UserTimeService} or the new {@link java.time} package.
*/
public interface TimeService extends UserTimeService
{
/** The type string for this "application": should not change over time as it may be stored in various parts of persistent entities. */
static final String APPLICATION_ID = "sakai:time";
/** Preferences key for user's time zone */
public static final String TIMEZONE_KEY = "timezone";
/**
* Get a time object.
*
* @return A time object, set to now.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
Time newTime();
/**
* Get a time object, set from this string in our format, Gmt values
*
* @param value
* time format string.
* @return A time object.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
Time newTimeGmt(String value);
/**
* Get a time object, set from this long milliseconds since the "epoc" value.
*
* @param value
* time long milliseconds value.
* @return A time object.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
Time newTime(long value);
/**
* Get a time object, based on the time set in the calendar
*
* @return A time object, set to now.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
Time newTime(GregorianCalendar cal);
/**
* Get a time object, set from individual ints, Gmt values
*
* @param year
* full year (i.e. 1999, 2000)
* @param month
* month in year (1..12)
* @param day
* day in month (1..31)
* @param hour
* hour in day (0..23)
* @param minute
* minute in hour (0..59)
* @param second
* second in minute (0..59)
* @param millisecond
* millisecond in second (0..999)
* @return A time object.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
Time newTimeGmt(int year, int month, int day, int hour, int minute, int second, int millisecond);
/**
* Get a time object, set from this breakdown (Gmt values).
*
* @param breakdown
* The time breakdown values.
* @return A time object.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
Time newTimeGmt(TimeBreakdown breakdown);
/**
* Get a time object, set from individual ints, Local values
*
* @param year
* full year (i.e. 1999, 2000)
* @param month
* month in year (1..12)
* @param day
* day in month (1..31)
* @param hour
* hour in day (0..23)
* @param minute
* minute in hour (0..59)
* @param second
* second in minute (0..59)
* @param millisecond
* millisecond in second (0..999)
* @return A time object.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
Time newTimeLocal(int year, int month, int day, int hour, int minute, int second, int millisecond);
/**
* Get a time object, set from this breakdown (Local values).
*
* @param breakdown
* The time breakdown values.
* @return A time object.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
Time newTimeLocal(TimeBreakdown breakdown);
/**
* Get a TimeBreakdown object, set from individual ints.
*
* @param year
* full year (i.e. 1999, 2000)
* @param month
* month in year (1..12)
* @param day
* day in month (1..31)
* @param hour
* hour in day (0..23)
* @param minute
* minute in hour (0..59)
* @param second
* second in minute (0..59)
* @param millisecond
* millisecond in second (0..999)
* @return A TimeBreakdown.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
TimeBreakdown newTimeBreakdown(int year, int month, int day, int hour, int minute, int second, int millisecond);
/**
* Get a TimeRange, from parts.
*
* @param start
* The start Time.
* @param end
* The end Time.
* @param startIncluded
* true if start is part of the range, false if not.
* @param endIncluded
* true of end is part of the range, false if not.
* @return A TimeRange.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
TimeRange newTimeRange(Time start, Time end, boolean startIncluded, boolean endIncluded);
/**
* Get a TimeRange, from our string format.
*
* @param value
* The TimeRange string.
* @return A TimeRange.
*/
TimeRange newTimeRange(String value);
/**
* Get a TimeRange, from a single time.
*
* @param startAndEnd
* The Time for the range.
* @return A TimeRange.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
TimeRange newTimeRange(Time startAndEnd);
/**
* Get a TimeRange, from a time value long start and duration
*
* @param start
* The long start time (milliseconds since).
* @param duration
* The long milliseconds duration.
* @return A TimeRange.
*
*/
TimeRange newTimeRange(long start, long duration);
/**
* Get a TimeRange, from two times, inclusive.
*
* @param start
* The start time.
* @param end
* The end time.
* @return A TimeRange.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
TimeRange newTimeRange(Time start, Time end);
/**
* Get a TimeRange, from two Instant objects, inclusive.
*
* @param start
* The start time as an Instant
* @param end
* The end time as an Instant
* @return A TimeRange.
*/
TimeRange newTimeRange(Instant start, Instant end);
/**
* Get a Calendar, set to this zone and these values.
*
* @param zone
* The TimeZone for the calendar.
* @param year
* full year (i.e. 1999, 2000)
* @param month
* month in year (1..12)
* @param day
* day in month (1..31)
* @param hour
* hour in day (0..23)
* @param min
* minute in hour (0..59)
* @param second
* second in minute (0..59)
* @param ms
* millisecond in second (0..999)
*/
GregorianCalendar getCalendar(TimeZone zone, int year, int month, int day, int hour, int min, int second, int ms);
/**
* Compare two Time for differences, either may be null
*
* @param a
* One Time.
* @param b
* The other Time.
* @return true if the Times are different, false if they are the same.
* @deprecated the use of time is discouraged in favour of {@link java.time.Instant}. This interface will be removed in 2.0
*/
boolean different(Time a, Time b);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy