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

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

This session defines views that offer differing behaviors for searching.

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

Recurring event enablers may have a query record indicated by their respective record types. The query record is accessed via the RecurringEventEnablerQuery.

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchRecurringEventEnablers
Description

Tests if this user can perform RecurringEventEnabler 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 not offer lookup 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 event enablers in calendars which are children of this broker 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.
MethodgetRecurringEventEnablerQuery
Description

Gets a recurring event enabler query.

Returnosid.calendaring.rules.RecurringEventEnablerQuerythe recurring event enabler query
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventEnablersByQuery
Description

Gets a list of RecurringEventEnablers matching the given recurring event enabler query.

Parametersosid.calendaring.rules.RecurringEventEnablerQueryrecurringEventEnablerQuerythe recurring event enabler query
Returnosid.calendaring.rules.RecurringEventEnablerListthe returned RecurringEventEnablerList
ErrorsNULL_ARGUMENT recurringEventEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED recurringEventEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.