Interface | osid.calendaring.CommitmentQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching commitments. Each method
match request produces an | ||
Method | matchEventId | ||
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 | clearEventIdTerms | ||
Description |
Clears the event | ||
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 | clearEventTerms | ||
Description |
Clears the event terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchResourceId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearResourceIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceQuery | ||
Description |
Gets the query for a resource. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsResourceQuery() is false | |
Compliance | optional | This method must be implemented if supportsResourceQuery()
is true. | |
Method | clearResourceTerms | ||
Description |
Clears the resource 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 | getCommitmentQueryRecord | ||
Description |
Gets the commitment query record corresponding to the
given | ||
Parameters | osid.type.Type | commitmentRecordType | a commitment query record type |
Return | osid.calendaring.records.CommitmentQueryRecord | the commitment query record | |
Errors | NULL_ARGUMENT | commitmentRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(commitmentRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |