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

Interface	osid.hold.rules.IssueConstrainerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.hold.rules.IssueConstrainerEnablerQuerySession`
	`osid.hold.rules.IssueConstrainerEnablerSearchSession`
	`osid.hold.rules.IssueConstrainerEnablerSmartOublietteSession`
Description	This is the query for searching issue constrainer enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledIssueConstrainerId
Description	Matches constrainer enablers mapped to the issue constrainer.
Parameters	`osid.id.Id`	`issueConstrainerId`	the issue constrainer `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`issueConstrainerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledIssueConstrainerIdTerms
Description	Clears the issue constrainer `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledIssueConstrainerQuery
Description	Tests if an `IssueConstrainerQuery` is available.
Return	`boolean`		`true` if an issue constrainer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledIssueConstrainerQuery
Description	Gets the query for an issue constrainer. Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.rules.IssueConstrainerQuery`		the issue constrainer query
Errors	UNIMPLEMENTED		`supportsRuledIssueConstrainerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledIssueConstrainerQuery()` is `true`.
Method	matchAnyRuledIssue
Description	Matches enablers mapped to any issue constrainer.
Parameters	`boolean`	`match`	`true` for processors mapped to any issue constrainer, `false` to match processors mapped to no issue constrainer
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledIssueTerms
Description	Clears the issue constrainer query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOublietteId
Description	Sets the oubliette `Id` for this query to match issues 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	getIssueConstrainerEnablerQueryRecord
Description	Gets the issue constrainer enabler query record corresponding to the given `IssueConstrainerEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`issueConstrainerEnablerRecordType`	an issue constrainer enabler record type
Return	`osid.hold.rules.records.IssueConstrainerEnablerQueryRecord`		the issue constrainer enabler query record
Errors	NULL_ARGUMENT		`issueConstrainerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(issueConstrainerEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.