Interface | osid.calendaring.SupersedingEventQuery | ||
---|---|---|---|
Implements | osid.OsidRuleQuery | ||
Description |
This is the query for searching superseding events. Each
method match request produces an | ||
Method | matchSupersededEventId | ||
Description |
Sets the event | ||
Parameters | osid.id.Id | eventId | an event Id |
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 | clearSupersededEventIdTerms | ||
Description |
Clears the event | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSupersededEventQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an event query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSupersededEventQuery | ||
Description |
Gets the query for an attached event. Multiple
retrievals produce a nested | ||
Return | osid.calendaring.EventQuery | the event query | |
Errors | UNIMPLEMENTED | supportsSupersededEventQuery() is false | |
Compliance | optional | This method must be implemented if supportsSupersededEventQuery()
is true. | |
Method | clearSupersededEventTerms | ||
Description |
Clears the event terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSupersedingEventId | ||
Description |
Sets the superseding event | ||
Parameters | osid.id.Id | supersedingEventId | a superseding event Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | supersedingEventId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSupersedingEventIdTerms | ||
Description |
Clears the superseding event | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSupersedingEventQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a superseding event query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventQuery | ||
Description |
Gets the query for a superseding event. Multiple
retrievals produce a nested | ||
Return | osid.calendaring.EventQuery | the superseding event query | |
Errors | UNIMPLEMENTED | supportsSupersedingEventQuery() is false | |
Compliance | optional | This method must be implemented if supportsSupersedingEventQuery()
is true. | |
Method | clearSupersedingEventTerms | ||
Description |
Clears the superseding event terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSupersededDate | ||
Description |
Matches superseding events that supersede within the given dates inclusive. | ||
Parameters | osid.calendaring.DateTime | from | start date |
osid.calendaring.DateTime | to | end date | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnySupersededDate | ||
Description |
Matches a superseding event that has any superseded date. | ||
Parameters | boolean | match | true to match superseding events with any superseded date,
false to match superseding events with no superseded date |
Compliance | mandatory | This method must be implemented. | |
Method | clearSupersededDateTerms | ||
Description |
Clears the superseded date terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSupersededEventPosition | ||
Description |
Matches superseding events that supersede within the denormalized event positions inclusive. | ||
Parameters | integer | from | start position |
integer | to | end position | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | the absolute value of from is greater than to | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnySupersededEventPosition | ||
Description |
Matches a superseding event that has any superseded position. | ||
Parameters | boolean | match | true to match superseding events with any superseded event
position, false to match superseding events with no superseded event position |
Compliance | mandatory | This method must be implemented. | |
Method | clearSupersededEventPositionTerms | ||
Description |
Clears the superseded position 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 | getSupersedingEventQueryRecord | ||
Description |
Gets the superseding event query record corresponding
to the given | ||
Parameters | osid.type.Type | supersedingEventRecordType | a superseding event query record type |
Return | osid.calendaring.records.SupersedingEventQueryRecord | the superseding event query record | |
Errors | NULL_ARGUMENT | supersedingEventRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(supersedingEventRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |