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

Interface	osid.inquiry.rules.AuditConstrainerQuery
Implements	`osid.OsidConstrainerQuery`
Used By	`osid.inquiry.rules.AuditConstrainerEnablerQuery`
	`osid.inquiry.rules.AuditConstrainerQuerySession`
	`osid.inquiry.rules.AuditConstrainerSearchSession`
	`osid.inquiry.rules.AuditConstrainerSmartInquestSession`
Description	This is the query for searching audit constrainers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledAuditId
Description	Matches constrainers mapped to the audit.
Parameters	`osid.id.Id`	`auditId`	the audit `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`auditId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledAuditIdTerms
Description	Clears the audit `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledAuditQuery
Description	Tests if an `AuditQuery` is available.
Return	`boolean`		`true` if an audit query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledAuditQuery
Description	Gets the query for an audit. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.AuditQuery`		the audit query
Errors	UNIMPLEMENTED		`supportsRuledAuditQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledAuditQuery()` is `true`.
Method	matchAnyRuledAudit
Description	Matches enablers mapped to any audit.
Parameters	`boolean`	`match`	`true` for enablers mapped to any audit, `false` to match enablers mapped to no audits
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledAuditTerms
Description	Clears the audit 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	getAuditConstrainerQueryRecord
Description	Gets the audit constrainer query record corresponding to the given `AuditConstrainer` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`auditConstrainerRecordType`	an audit constrainer record type
Return	`osid.inquiry.rules.records.AuditConstrainerQueryRecord`		the audit constrainer query record
Errors	NULL_ARGUMENT		`auditConstrainerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(auditConstrainerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.