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

This session provides methods for retrieving SupersedingEvents.

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 superseding event methods in this session operate, retrieve and pertain to superseding events defined explicitly in the current calendar. Using an isolated view is useful for managing events with the SupersedingEventAdminSession.
  • federated calendar view: All superseding event methods in this session operate, retrieve and pertain to all superseding events defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence.
  • active superseding event view: All superseding event lookup methods return active superseding events.
  • any status superseding event view: Superseding events of any active or inactive status are returned from methods.
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.
MethodcanLookupSupersedingEvents
Description

Tests if this user can perform SupersedingEvent 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.
MethoduseComparativeSupersedingEventView
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.
MethodusePlenarySupersedingEventView
Description

A complete view of the SupersedingEvent 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 supserseding events 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.
MethoduseActiveSupersedingEventView
Description

Only active superseding events are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusSupersedingEventView
Description

All active and inactive superseding events are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetSupersedingEvent
Description

Gets the Superseding specified by its Id.

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

In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parametersosid.id.IdsupersedingEventId Id of the SupersedingEvent
Returnosid.calendaring.SupersedingEventthe superseding event
ErrorsNOT_FOUND supersedngEventId not found
NULL_ARGUMENT supersedingEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetSupersedingEventsByIds
Description

Gets a SupersedingEventList corresponding to the given IdList.

In plenary mode, the returned list contains all of the superseding events 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 SupersedingEvents may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parametersosid.id.IdListsupersedingEventIdsthe list of Ids to retrieve
Returnosid.calendaring.SupersedingEventListthe returned SupersedingEvent list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT supersedingEventIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventsByGenusType
Description

Gets a SupersedingEventList corresponding to the given superseding event genus Type which does not include superseding events of genus types derived from the specified Type.

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

In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parametersosid.type.TypesupersedingEventGenusTypea superseding event genus type
Returnosid.calendaring.SupersedingEventListthe returned SupersedingEvent list
ErrorsNULL_ARGUMENT supersedingEventGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventsByParentGenusType
Description

Gets a SupersedingEventList corresponding to the given superseding event genus Type and include any additional superseding event with genus types derived from the specified Type.

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

In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parametersosid.type.TypesupersedingEventGenusTypea superseding event genus type
Returnosid.calendaring.SupersedingEventListthe returned SupersedingEvent list
ErrorsNULL_ARGUMENT supersedingEventGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventsByRecordType
Description

Gets a SupersedingEventList containing the given superseding event record Type.

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

In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parametersosid.type.TypesupersedingEventRecordTypea superseding event record type
Returnosid.calendaring.SupersedingEventListthe returned SupersedingEvent list
ErrorsNULL_ARGUMENT supersedingEventRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventsBySupersededEvent
Description

Gets the SupersedingEvents related to the relative event Id.

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

In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Parametersosid.id.IdsupersededEventId Id of the related event
Returnosid.calendaring.SupersedingEventListthe superseding events
ErrorsNOT_FOUND supersededEventId not found
NULL_ARGUMENT supersededEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetSupersedingEvents
Description

Gets all SupersedingEvents.

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

In active mode, supersdeing events are returned that are currently active. In any status mode, active and inactive superseding events are returned.

Returnosid.calendaring.SupersedingEventLista SupersedingEventList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.