OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CyclicEventQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching cyclic events. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

MethodmatchEventId
Description

Matches cyclic events that are related to the given event.

Parametersosid.id.IdeventIdan Id for an event
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT eventId is null
CompliancemandatoryThis method must be implemented.
MethodclearEventIdTerms
Description

Clears the event terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEventQuery
Description

Tests if an EventQuery is available.

Returnboolean true if an event query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEventQuery
Description

Gets the query for an event. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.EventQuerythe event query
ErrorsUNIMPLEMENTED supportsEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsEventQuery() is true.
MethodmatchAnyEvent
Description

Matches a cyclic event that has any related event.

Parametersbooleanmatch true to match cyclic events with any event, false to match cyclic events with no related events
CompliancemandatoryThis method must be implemented.
MethodclearEventTerms
Description

Clears the event terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCalendarId
Description

Sets the calendar Id for this query.

Parametersosid.id.IdcalendarIda calendar Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT calendarId is null
CompliancemandatoryThis method must be implemented.
MethodclearCalendarIdTerms
Description

Clears the calendar Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCalendarQuery
Description

Tests if a CalendarQuery is available for querying calendars.

Returnboolean true if a calendar query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCalendarQuery
Description

Gets the query for a calendar. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.CalendarQuerythe calendar query
ErrorsUNIMPLEMENTED supportsCalendarQuery() is false
ComplianceoptionalThis method must be implemented if supportsCalendarQuery() is true.
MethodclearCalendarTerms
Description

Clears the calendar terms.

CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventQueryRecord
Description

Gets the cyclic event query record corresponding to the given CyclicEvent record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypecyclicEventRecordTypea cyclic event query record type
Returnosid.calendaring.cycle.records.CyclicEventQueryRecordthe cyclic event query record
ErrorsNULL_ARGUMENT cyclicEventRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cyclicEventRecordType) is false
CompliancemandatoryThis method must be implemented.