OSID - osid.calendaring.rules.CommitmentEnablerQuery Service Interface Definition

Interface	osid.calendaring.rules.CommitmentEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.calendaring.rules.CommitmentEnablerQuerySession`
	`osid.calendaring.rules.CommitmentEnablerSearchSession`
	`osid.calendaring.rules.CommitmentEnablerSmartCalendarSession`
Description	This is the query for searching commitment enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledCommitmentId
Description	Matches enablers mapped to the commitment.
Parameters	`osid.id.Id`	`commitmentId`	the commitment book `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`commitmentBookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledCommitmentIdTerms
Description	Clears the commitment `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledCommitmentQuery
Description	Tests if a `CommitmentBookQuery` is available.
Return	`boolean`		`true` if a commitment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledCommitmentQuery
Description	Gets the query for a commitment. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.CommitmentQuery`		the calendar query
Errors	UNIMPLEMENTED		`supportsCommitmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommitmentQuery()` is `true`.
Method	matchAnyRuledCommitment
Description	Matches enablers mapped to any commitment.
Parameters	`boolean`	`match`	`true` for enablers mapped to any commitment, `false` to match enablers mapped to no commitment
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledCommitmentTerms
Description	Clears the commitment query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCalendarId
Description	Matches enablers mapped to the calendar.
Parameters	`osid.id.Id`	`calendarId`	the 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` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarQuery
Description	Tests if a `CalendarQuery` is available.
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 query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablerQueryRecord
Description	Gets the commitment enabler query record corresponding to the given `CommitmentEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`commitmentEnablerRecordType`	a commitment enabler record type
Return	`osid.calendaring.rules.records.CommitmentEnablerQueryRecord`		the commitment enabler query record
Errors	NULL_ARGUMENT		`commitmentEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(commitmentEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.