OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.TimePeriodLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving TimePeriod objects. The TimePeriod represents a period of time in which to manage recurring events.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated calendar view: All time period methods in this session operate, retrieve and pertain to time periods defined explicitly in the current calendar. Using an isolated view is useful for managing time periods with the TimePeriodAdminSession.
  • federated calendar view: All time period methods in this session operate, retrieve and pertain to all time periods defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence.

Time periods may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the TimePeriod.

MethodgetCalendarId
Description

Gets the Calendar Id associated with this session.

Returnosid.id.Idthe Calendar Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCalendar
Description

Gets the Calendar associated with this session.

Returnosid.calendaring.Calendarthe Calendar associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupTimePeriods
Description

Tests if this user can perform TimePeriod lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeTimePeriodView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryTimePeriodView
Description

A complete view of the TimePeriod returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedCalendarView
Description

Federates the view for methods in this session. A federated view will include time periods in calendars which are children of this calendar in the calendar hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCalendarView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.

CompliancemandatoryThis method is must be implemented.
MethodgetTimePeriod
Description

Gets the TimePeriod specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned TimePeriod may have a different Id than requested, such as the case where a duplicate Id was assigned to a TimePeriod and retained for compatibility.

Parametersosid.id.IdtimePeriodId Id of the TimePeriod
Returnosid.calendaring.TimePeriodthe time period
ErrorsNOT_FOUND timePeriodId not found
NULL_ARGUMENT timePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetTimePeriodsByIds
Description

Gets a TimePeriodList corresponding to the given IdList. In plenary mode, the returned list contains all of the time periods specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible TimePeriods may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListtimePeriodIdsthe list of Ids to retrieve
Returnosid.calendaring.TimePeriodListthe returned TimePeriod list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT rimePeriodIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodsByGenusType
Description

Gets a TimePeriodList corresponding to the given time period genus Type which does not include time periods of genus types derived from the specified Type. In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.

Parametersosid.type.TypetimePeriodGenusTypea time period genus type
Returnosid.calendaring.TimePeriodListthe returned TimePeriod list
ErrorsNULL_ARGUMENT timePeriodGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodsByParentGenusType
Description

Gets a TimePeriodList corresponding to the given time period genus Type and include any additional time periods with genus types derived from the specified Type. In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.

Parametersosid.type.TypetimePeriodGenusTypea time period genus type
Returnosid.calendaring.TimePeriodListthe returned TimePeriod list
ErrorsNULL_ARGUMENT timePeriodGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodsByRecordType
Description

Gets a TimePeriodList containing the given time period record Type. In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.

Parametersosid.type.TypetimePeriodRecordTypea time period record type
Returnosid.calendaring.TimePeriodListthe returned TimePeriod list
ErrorsNULL_ARGUMENT timePeriodRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodsByDate
Description

Gets a TimePeriodList containing the given DateTime. Time periods containing the given date are matched. In plenary mode, the returned list contains all of the time periods specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible TimePeriods may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.calendaring.DateTimedatetimea date
Returnosid.calendaring.TimePeriodListthe returned TimePeriod list
ErrorsNULL_ARGUMENT datetime is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodsInDateRange
Description

Gets a TimePeriodList corresponding to the given DateTime. Time periods whose start end end times are included in the given date range are matched.In plenary mode, the returned list contains all of the time periods specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible TimePeriods may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.calendaring.DateTimestartstart of daterange
osid.calendaring.DateTimeendend of date range
Returnosid.calendaring.TimePeriodListthe returned TimePeriod list
ErrorsINVALID_ARGUMENT end is less than start
NULL_ARGUMENT start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriods
Description

Gets all TimePeriods. In plenary mode, the returned list contains all known time periods or an error results. Otherwise, the returned list may contain only those time periods that are accessible through this session.

Returnosid.calendaring.TimePeriodLista TimePeriodList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.