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

This session provides methods for searching RecurringEvent objects. The search query is constructed using the RecurringEventQuery. The recurring event record Type also specifies the record for the recurring event query.

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include recurring events in calendars of which this calendar is an ancestor in the calendar hierarchy
  • isolated calendar view: searches are restricted to recurring events in this calendar

RecurringEvents may have a query record indicated by their respective record types. The query ecord is accessed via the RecurringEventQuery.

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

Tests if this user can perform RecurringEvents searches. 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 search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCalendarView
Description

Federates the view for methods in this session. A federated view will include recurring 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 searches to this calendar only.

CompliancemandatoryThis method is must be implemented.
MethodgetRecurringEventQuery
Description

Gets a recurring event query.

Returnosid.calendaring.RecurringEventQuerythe recurring event query
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventsByQuery
Description

Gets a list of RecurringEvents matching the given recurring event query.

Parametersosid.calendaring.RecurringEventQueryrecurringEventQuerythe recurring event query
Returnosid.calendaring.RecurringEventListthe returned RecurringEventList
ErrorsNULL_ARGUMENT recurringEventQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED recurringEventQuery is not of this service
CompliancemandatoryThis method must be implemented.