OSID - osid.calendaring.CommitmentQuery Service Interface Definition

Interface	osid.calendaring.CommitmentQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.calendaring.CalendarQuery`
	`osid.calendaring.CommitmentQuerySession`
	`osid.calendaring.CommitmentSearchSession`
	`osid.calendaring.CommitmentSmartCalendarSession`
	`osid.calendaring.EventQuery`
	`osid.calendaring.rules.CommitmentEnablerQuery`
Description	This is the query for searching commitments. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR`.
Method	matchEventId
Description	Sets the event `Id` for this query.
Parameters	`osid.id.Id`	`eventId`	an event `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEventQuery
Description	Tests if an `EventQuery` is available.
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 `OR` term.
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 `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
Description	Tests if a `ResourceQuery` is available for querying resources.
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 `OR` term.
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 `Id` for this query.
Parameters	`osid.id.Id`	`calendarId`	a calendar `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarQuery
Description	Tests if a `CalendarQuery` is available for querying resources.
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 `OR` term.
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 `Commitment` record `Type`. Multiple retrievals produce a nested `OR` term.
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.