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

This session provides methods to retrieve Event to Calendar mappings. An Event 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
  • normalized event view: a single recurring event is used to represent a series of events
  • denormalized view: recurring events are expanded into individual events
MethodcanLookupEventCalendarMappings
Description

Tests if this user can perform lookups of event/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 Event 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.
MethoduseNormalizedEventView
Description

A normalized view sends a single notification for recurring events.

CompliancemandatoryThis method is must be implemented.
MethoduseDenormalizedEventView
Description

A denormalized view sends a separate notification for each event in a recurring set.

CompliancemandatoryThis method is must be implemented.
MethodgetEventIdsByCalendar
Description

Gets the list of Event Ids associated with a Calendar.

Parametersosid.id.IdcalendarId Id of the Calendar
Returnosid.id.IdListlist of related event 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.
MethodgetEventsByCalendar
Description

Gets the list of Events associated with a Calendar.

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

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

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

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

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

Gets the list of Calendar Ids mapped to an Event.

Parametersosid.id.IdeventId Id of an Event
Returnosid.id.IdListlist of calendar Ids
ErrorsNOT_FOUND eventId is not found
NULL_ARGUMENT eventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCalendarsByEvent
Description

Gets the list of Calendars mapped to an Event.

Parametersosid.id.IdeventId Id of an Event
Returnosid.calendaring.CalendarListlist of calendars
ErrorsNOT_FOUND eventId is not found
NULL_ARGUMENT eventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.