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

Interface	osid.inquiry.rules.AuditConstrainerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.inquiry.rules.AuditConstrainerEnablerQuerySession`
	`osid.inquiry.rules.AuditConstrainerEnablerSearchSession`
	`osid.inquiry.rules.AuditConstrainerEnablerSmartInquestSession`
Description	This is the query for searching audit constrainer enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledAuditConstrainerId
Description	Matches enablers mapped to the audit constrainer.
Parameters	`osid.id.Id`	`auditConstrainerId`	the audit constrainer `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`auditConstrainerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledAuditConstrainerIdTerms
Description	Clears the audit constrainer `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledAuditConstrainerQuery
Description	Tests if an `AuditConstrainerQuery` is available.
Return	`boolean`		`true` if an audit constrainer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledAuditConstrainerQuery
Description	Gets the query for an audit constrainer. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.rules.AuditConstrainerQuery`		the audit constrainer query
Errors	UNIMPLEMENTED		`supportsRuledAuditConstraienrQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledAuditConstrainerQuery()` is `true`.
Method	matchAnyRuledAuditConstrainer
Description	Matches enablers mapped to any audit constrainer.
Parameters	`boolean`	`match`	`true` for enablers mapped to any audit constrainer, `false` to match enablers mapped to no audit constrainers
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledAuditConstrainerTerms
Description	Clears the audit constrainer 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	getAuditConstrainerEnablerQueryRecord
Description	Gets the audit constrainer enabler query record corresponding to the given `AuditConstrainerEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`auditConstrainerEnablerRecordType`	an audit constrainer enabler record type
Return	`osid.inquiry.rules.records.AuditConstrainerEnablerQueryRecord`		the audit constrainer enabler query record
Errors	NULL_ARGUMENT		`auditConstrainerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(auditConstrainerEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.