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

Interface	osid.hold.rules.IssueProcessorEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.hold.rules.IssueProcessorEnablerQuerySession`
	`osid.hold.rules.IssueProcessorEnablerSearchSession`
	`osid.hold.rules.IssueProcessorEnablerSmartOublietteSession`
Description	This is the query for searching issue processor enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledIssueProcessorId
Description	Matches processor enablers mapped to the issue processor.
Parameters	`osid.id.Id`	`issueProcessorId`	the issue processor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`issueProcessorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledIssueProcessorIdTerms
Description	Clears the issue processor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledIssueProcessorQuery
Description	Tests if an `IssueProcessorQuery` is available.
Return	`boolean`		`true` if an issue processor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledIssueProcessorQuery
Description	Gets the query for an issue processor. Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.rules.IssueProcessorQuery`		the issue processor query
Errors	UNIMPLEMENTED		`supportsRuledIssueProcessorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledIssueProcessorQuery()` is `true`.
Method	matchAnyRuledIssue
Description	Matches enablers mapped to any issue processor.
Parameters	`boolean`	`match`	`true` for processors mapped to any issue processor, `false` to match processors mapped to no issue processor
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledIssueTerms
Description	Clears the issue processor 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	getIssueProcessorEnablerQueryRecord
Description	Gets the issue processor enabler query record corresponding to the given `IssueProcessorEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`issueProcessorEnablerRecordType`	an issue processor enabler record type
Return	`osid.hold.rules.records.IssueProcessorEnablerQueryRecord`		the issue processor enabler query record
Errors	NULL_ARGUMENT		`issueProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(issueProcessorEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.