OSID - osid.hold.rules.IssueEnablerQuery Service Interface Definition

Interface	osid.hold.rules.IssueEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.hold.rules.IssueEnablerQuerySession`
	`osid.hold.rules.IssueEnablerSearchSession`
	`osid.hold.rules.IssueEnablerSmartOublietteSession`
Description	This is the query for searching issue enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledIssueId
Description	Matches enablers mapped to the issue.
Parameters	`osid.id.Id`	`issueId`	the issue `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`issueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledIssueIdTerms
Description	Clears the issue `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledIssueQuery
Description	Tests if an `IssueQuery` is available.
Return	`boolean`		`true` if an issue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledIssueQuery
Description	Gets the query for an issue. Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.IssueQuery`		the issue query
Errors	UNIMPLEMENTED		`supportsRuledIssueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledIssueQuery()` is `true`.
Method	matchAnyRuledIssue
Description	Matches enablers mapped to any issue.
Parameters	`boolean`	`match`	`true` for enablers mapped to any issue, `false` to match enablers mapped to no issue
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledIssueTerms
Description	Clears the issue query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOublietteId
Description	Sets the oubliette `Id` for this query to match issue enablers assigned to oubliettes.
Parameters	`osid.id.Id`	`oublietteId`	the oubliette `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`oublietteId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOublietteIdTerms
Description	Clears the oubliette `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOublietteQuery
Description	Tests if an `OublietteQuery` is available.
Return	`boolean`		`true` if an oubliette query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteQuery
Description	Gets the query for an oubliette. Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.OublietteQuery`		the oubliette query
Errors	UNIMPLEMENTED		`supportsOublietteQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOublietteQuery()` is `true`.
Method	clearOublietteTerms
Description	Clears the oubliette query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablerQueryRecord
Description	Gets the issue enabler query record corresponding to the given `IssueEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`issueEnablerRecordType`	an issue enabler record type
Return	`osid.hold.rules.records.IssueEnablerQueryRecord`		the issue enabler query record
Errors	NULL_ARGUMENT		`issueEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(issueEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.