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

This session provides methods for searching OffsetEvent objects. The search query is constructed using the OffsetEventQuery. The offset event record Type also specifies the record for the offset event query.

This session defines views that offer differing behaviors for searching.

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

OffsetEvents may have a query record indicated by their respective record types. The query record is accessed via the OffsetEventQuery.

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

Tests if this user can perform OffsetEvents 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 offset 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.
MethodgetOffsetEventQuery
Description

Gets an offset event query.

Returnosid.calendaring.OffsetEventQuerythe offset event query
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventsByQuery
Description

Gets a list of OffsetEvents matching the given offset event query.

Parametersosid.calendaring.OffsetEventQueryoffsetEventQuerythe offset event query
Returnosid.calendaring.OffsetEventListthe returned OffsetEventList
ErrorsNULL_ARGUMENT offsetEventQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED offsetEventQuery is not of this service
CompliancemandatoryThis method must be implemented.