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

This session provides methods to retrieve Schedule to Calendar mappings. A Schedule may appear in multiple Calendars. Each Calendar may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupScheduleCalendarMappings
Description

Tests if this user can perform lookups of schedule/calendar mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCalendarView
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.
MethodusePlenaryCalendarView
Description

A complete view of the Schedule and Calendar 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.
MethodgetScheduleIdsByCalendar
Description

Gets the list of Schedule Ids associated with a Calendar.

Parametersosid.id.IdcalendarId Id of the Calendar
Returnosid.id.IdListlist of related schedule Ids
ErrorsNOT_FOUND calendarId is not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSchedulesByCalendar
Description

Gets the list of Schedules associated with a Calendar.

Parametersosid.id.IdcalendarId Id of the Calendar
Returnosid.calendaring.ScheduleListlist of related schedules
ErrorsNOT_FOUND calendarId is not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetScheduleIdsByCalendars
Description

Gets the list of Schedule Ids corresponding to a list of Calendars.

Parametersosid.id.IdListcalendarIdslist of calendar Ids
Returnosid.id.IdListlist of schedule Ids
ErrorsNULL_ARGUMENT calendarIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSchedulesByCalendars
Description

Gets the list of Schedules corresponding to a list of Calendars.

Parametersosid.id.IdListcalendarIdslist of calendar Ids
Returnosid.calendaring.ScheduleListlist of schedules
ErrorsNULL_ARGUMENT calendarIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCalendarIdsBySchedule
Description

Gets the list of Calendar Ids mapped to a Schedule.

Parametersosid.id.IdscheduleId Id of a Schedule
Returnosid.id.IdListlist of calendar Ids
ErrorsNOT_FOUND scheduleId is not found
NULL_ARGUMENT scheduleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCalendarsBySchedule
Description

Gets the list of Calendars mapped to a Schedule.

Parametersosid.id.IdscheduleId Id of a Schedule
Returnosid.calendaring.CalendarListlist of calendars
ErrorsNOT_FOUND scheduleId is not found
NULL_ARGUMENT scheduleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.