Interface | osid.calendaring.cycle.CyclicEventQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching cyclic events. Each method
match request produces an | ||
Method | matchEventId | ||
Description |
Matches cyclic events that are related to the given event. | ||
Parameters | osid.id.Id | eventId | an Id for an event |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | eventId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearEventIdTerms | ||
Description |
Clears the event terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsEventQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an event query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEventQuery | ||
Description |
Gets the query for an event. Multiple retrievals
produce a nested | ||
Return | osid.calendaring.EventQuery | the event query | |
Errors | UNIMPLEMENTED | supportsEventQuery() is false | |
Compliance | optional | This method must be implemented if supportsEventQuery() is
true. | |
Method | matchAnyEvent | ||
Description |
Matches a cyclic event that has any related event. | ||
Parameters | boolean | match | true to match cyclic events with any event, false
to match cyclic events with no related events |
Compliance | mandatory | This method must be implemented. | |
Method | clearEventTerms | ||
Description |
Clears the event terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCalendarId | ||
Description |
Sets the calendar | ||
Parameters | osid.id.Id | calendarId | a calendar Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | calendarId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCalendarIdTerms | ||
Description |
Clears the calendar | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCalendarQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a calendar query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendarQuery | ||
Description |
Gets the query for a calendar. Multiple retrievals
produce a nested | ||
Return | osid.calendaring.CalendarQuery | the calendar query | |
Errors | UNIMPLEMENTED | supportsCalendarQuery() is false | |
Compliance | optional | This method must be implemented if supportsCalendarQuery()
is true. | |
Method | clearCalendarTerms | ||
Description |
Clears the calendar terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventQueryRecord | ||
Description |
Gets the cyclic event query record corresponding to the
given | ||
Parameters | osid.type.Type | cyclicEventRecordType | a cyclic event query record type |
Return | osid.calendaring.cycle.records.CyclicEventQueryRecord | the cyclic event query record | |
Errors | NULL_ARGUMENT | cyclicEventRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(cyclicEventRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |