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

This session provides methods for searching among Calendar objects. The search query is constructed using the CalendarQuery.

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

MethodcanSearchCalendars
Description

Tests if this user can perform Calendar 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.
MethodgetCalendarQuery
Description

Gets a calendar query.

Returnosid.calendaring.CalendarQuerya calendar query
CompliancemandatoryThis method must be implemented.
MethodgetCalendarsByQuery
Description

Gets a list of Calendar objects matching the given calendar query.

Parametersosid.calendaring.CalendarQuerycalendarQuerythe calendar query
Returnosid.calendaring.CalendarListthe returned CalendarList
ErrorsNULL_ARGUMENT calendarQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED calendarQuery is not of this service
CompliancemandatoryThis method must be implemented.