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

This session provides methods for retrieving CyclicEvent s.

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 event methods in this session operate, retrieve and pertain to cyclic events defined explicitly in the current calendar. Using an isolated view is useful for managing cyclic events with the CyclicEventAdminSession.
  • federated calendar view: All event methods in this session operate, retrieve and pertain to all cyclic events defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence.

Cyclic events may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the CyclicEvent.

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.
MethodcanLookupCyclicEvents
Description

Tests if this user can perform CyclicEvent 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.
MethoduseComparativeCyclicEventView
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.
MethodusePlenaryCyclicEventView
Description

A complete view of the CyclicEvent 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 cyclic 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.
MethodgetCyclicEvent
Description

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

Parametersosid.id.IdcyclicEventId Id of the CyclicEvent
Returnosid.calendaring.cycle.CyclicEventthe cyclic event
ErrorsNOT_FOUND cyclicEventId not found
NULL_ARGUMENT cyclicEventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetCyclicEventsByIds
Description

Gets a CyclicEventList corresponding to the given IdList. In plenary mode, the returned list contains all of the cyclic 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 CyclicEvents may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListcyclicEventIdsthe list of Ids to retrieve
Returnosid.calendaring.cycle.CyclicEventListthe returned CyclicEvent list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT cyclicEventIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventsByGenusType
Description

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

Parametersosid.type.TypecyclicEventGenusTypea cyclic event genus type
Returnosid.calendaring.cycle.CyclicEventListthe returned Event list
ErrorsNULL_ARGUMENT cyclicEventGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventsByParentGenusType
Description

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

Parametersosid.type.TypecyclicEventGenusTypea cyclic event genus type
Returnosid.calendaring.cycle.CyclicEventListthe returned CyclicEvent list
ErrorsNULL_ARGUMENT cyclicEventGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventsByRecordType
Description

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

Parametersosid.type.TypecyclicEventRecordTypea cyclic event record type
Returnosid.calendaring.cycle.CyclicEventListthe returned Event list
ErrorsNULL_ARGUMENT cyclicEventRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEvents
Description

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

Returnosid.calendaring.cycle.CyclicEventLista CyclicEventList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.