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

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

This lookup session defines several views:

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

Tests if this user can perform lookups of superseding event enabler/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.
MethoduseComparativeSupersedingEventEnablerCalendarView
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.
MethodusePlenarySupersedingEventEnablerCalendarView
Description

A complete view of the SupersedingEventEnabler 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.
MethodgetSupersedingEventEnablerIdsByCalendar
Description

Gets the list of SupersedingEventEnabler Ids associated with a Calendar.

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

Gets the list of superseding event enablers associated with a Calendar.

Parametersosid.id.IdcalendarId Id of the Calendar
Returnosid.calendaring.rules.SupersedingEventEnablerListlist of related superseding event enablers
ErrorsNOT_FOUND calendarId is not found
NULL_ARGUMENT calendarId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventEnablerIdsByCalendars
Description

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

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

Gets the list of superseding event enablers corresponding to a list of Calendars.

Parametersosid.id.IdListcalendarIdslist of calendar Ids
Returnosid.calendaring.rules.SupersedingEventEnablerListlist of superseding event enablers
ErrorsNULL_ARGUMENT calendarIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCalendarIdsBySupersedingEventEnabler
Description

Gets the Calendar Ids mapped to a SupersedingEventEnabler.

Parametersosid.id.IdsupersedingEventEnablerId Id of a SupersedingEventEnabler
Returnosid.id.IdListlist of calendars
ErrorsNOT_FOUND supersedingEventEnablerId is not found
NULL_ARGUMENT supersedingEventEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCalendarsBySupersedingEventEnabler
Description

Gets the Calendars mapped to a SupersedingEventEnabler.

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