OSID - osid.assessment.authoring.SequenceRuleEnablerQuery Service Interface Definition

Interface	osid.assessment.authoring.SequenceRuleEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.assessment.authoring.SequenceRuleEnablerQuerySession`
	`osid.assessment.authoring.SequenceRuleEnablerSearchSession`
	`osid.assessment.authoring.SequenceRuleEnablerSmartBankSession`
Description	This is the query for searching sequence rule enablers. Each method match specifies a `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledSequenceRuleId
Description	Matches enablers mapped to the sequence rule.
Parameters	`osid.id.Id`	`sequenceRuleId`	the sequence rule `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`sequenceRuleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledSequenceRuleIdTerms
Description	Clears the sequence rule `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledSequenceRuleQuery
Description	Tests if a `SequenceRuleQuery` is available.
Return	`boolean`		`true` if a sequence rule query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledSequenceRuleQuery
Description	Gets the query for a sequence rule. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.authoring.SequenceRuleQuery`		the sequence rule query
Errors	UNIMPLEMENTED		`supportsRuledSequenceRuleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledSequenceRuleQuery()` is `true`.
Method	matchAnyRuledSequenceRule
Description	Matches enablers mapped to any sequence rule.
Parameters	`boolean`	`match`	`true` for enablers mapped to any sequence rule, `false` to match enablers mapped to no sequence rules
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledSequenceRuleTerms
Description	Clears the sequence rule query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBankId
Description	Matches enablers mapped to the bank.
Parameters	`osid.id.Id`	`bankId`	the bank `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`bankId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBankIdTerms
Description	Clears the bank `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBankQuery
Description	Tests if an `BankQuery` is available.
Return	`boolean`		`true` if a bank query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBankQuery
Description	Gets the query for a bank. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.BankQuery`		the bank query
Errors	UNIMPLEMENTED		`supportsBankQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBankQuery()` is `true`.
Method	clearBankTerms
Description	Clears the bank query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleEnablerQueryRecord
Description	Gets the sequence rule enabler query record corresponding to the given `SequenceRuleEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`sequenceRuleEnablerRecordType`	a sequence rule enabler record type
Return	`osid.assessment.authoring.records.SequenceRuleEnablerQueryRecord`		the sequence rule enabler query record
Errors	NULL_ARGUMENT		`sequenceRuleEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(sequenceRuleEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.