OSID - osid.inquiry.rules.AuditProcessorEnablerQuery Service Interface Definition

Interface	osid.inquiry.rules.AuditProcessorEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.inquiry.rules.AuditProcessorEnablerQuerySession`
	`osid.inquiry.rules.AuditProcessorEnablerSearchSession`
	`osid.inquiry.rules.AuditProcessorEnablerSmartInquestSession`
Description	This is the query for searching audit processor enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledAuditProcessorId
Description	Matches enablers mapped to the audit processor.
Parameters	`osid.id.Id`	`auditProcessorId`	the audit processor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`auditProcessorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledAuditProcessorIdTerms
Description	Clears the audit processor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledAuditProcessorQuery
Description	Tests if an `AuditProcessorQuery` is available.
Return	`boolean`		`true` if an audit processor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledAuditProcessorQuery
Description	Gets the query for an audit processor. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.rules.AuditProcessorQuery`		the audit processor query
Errors	UNIMPLEMENTED		`supportsRuledAuditProcessorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledAuditProcessorQuery()` is `true`.
Method	matchAnyRuledAuditProcessor
Description	Matches enablers mapped to any audit processor.
Parameters	`boolean`	`match`	`true` for enablers mapped to any audit processor, `false` to match enablers mapped to no audit processors
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledAuditProcessorTerms
Description	Clears the audit processor query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInquestId
Description	Sets the inquest `Id` for this query to match audits assigned to inquests.
Parameters	`osid.id.Id`	`inquestId`	the inquest `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`inquestId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInquestIdTerms
Description	Clears the inquest `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestQuery
Description	Tests if an `InquestQuery` is available.
Return	`boolean`		`true` if an inquest query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInquestQuery
Description	Gets the query for an inquest. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.InquestQuery`		the inquest query
Errors	UNIMPLEMENTED		`supportsInquestQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInquestQuery()` is `true`.
Method	clearInquestTerms
Description	Clears the inquest query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorEnablerQueryRecord
Description	Gets the audit processor enabler query record corresponding to the given `AuditProcessorEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`auditProcessorEnablerRecordType`	an audit processor enabler record type
Return	`osid.inquiry.rules.records.AuditProcessorEnablerQueryRecord`		the audit processor enabler query record
Errors	NULL_ARGUMENT		`auditProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(auditProcessorEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.