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

Interface	osid.assessment.authoring.SequenceRuleQuery
Implements	`osid.OsidRuleQuery`
Used By	`osid.assessment.authoring.SequenceRuleEnablerQuery`
	`osid.assessment.authoring.SequenceRuleQuerySession`
	`osid.assessment.authoring.SequenceRuleSearchSession`
	`osid.assessment.authoring.SequenceRuleSmartBankSession`
Description	This is the query for searching sequence rules. Each method match specifies a `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchAssessmentPartId
Description	Sets the assessment part `Id` for this query.
Parameters	`osid.id.Id`	`assessmentPartId`	an assessment part `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentPartId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentPartIdTerms
Description	Clears all assessment part `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentPartQuery
Description	Tests if an `AssessmentPartQuery` is available.
Return	`boolean`		`true` if an assessment part query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentPartQuery
Description	Gets the query for an assessment part. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.authoring.AssessmentPartQuery`		the assessment part query
Errors	UNIMPLEMENTED		`supportsAssessmentPartQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssessmentPartQuery()` is `true`.
Method	clearAssessmentPartTerms
Description	Clears all assessment part terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchNextAssessmentPartId
Description	Sets the assessment part `Id` for this query.
Parameters	`osid.id.Id`	`assessmentPartId`	an assessment part `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentPartId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearNextAssessmentPartIdTerms
Description	Clears all assessment part `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsNextAssessmentPartQuery
Description	Tests if an `AssessmentPartQuery` is available.
Return	`boolean`		`true` if an assessment part query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getNextAssessmentPartQuery
Description	Gets the query for an assessment part. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.authoring.AssessmentPartQuery`		the assessment part query
Errors	UNIMPLEMENTED		`supportsNextAssessmentPartQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsNextAssessmentPartQuery()` is `true`.
Method	clearNextAssessmentPartTerms
Description	Clears all assessment part terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumScore
Description	Matches minimum scores that fall in between the given scores inclusive.
Parameters	`cardinal`	`low`	low end of range
	`cardinal`	`high`	high end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumScore
Description	Matches assessment parts with any minimum score assigned.
Parameters	`boolean`	`match`	`true` to match assessment parts with any minimum score, `false` to match assessment parts with no minimum score
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumScoreTerms
Description	Clears all minimum score terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMaximumScore
Description	Matches maximum scores that fall in between the given scores inclusive.
Parameters	`cardinal`	`low`	low end of range
	`cardinal`	`high`	high end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMaximumScore
Description	Matches assessment parts with any maximum score assigned.
Parameters	`boolean`	`match`	`true` to match assessment parts with any maximum score, `false` to match assessment parts with no maximum score
Compliance	`mandatory`		This method must be implemented.
Method	clearMaximumScoreTerms
Description	Clears all maximum score terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCumulative
Description	Matches cumulative rules.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearCumulativeTerms
Description	Clears all cumulative terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAppliedAssessmentPartId
Description	Sets the assessment part `Id` for this query.
Parameters	`osid.id.Id`	`assessmentPartId`	an assessment part `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentPartId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAppliedAssessmentPartIdTerms
Description	Clears all assessment part `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAppliedAssessmentPartQuery
Description	Tests if an `AssessmentPartQuery` is available.
Return	`boolean`		`true` if an assessment part query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAppliedAssessmentPartQuery
Description	Gets the query for an assessment part. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.authoring.AssessmentPartQuery`		the assessment part query
Errors	UNIMPLEMENTED		`supportsAppliedAssessmentPartQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAppliedAssessmentPartQuery()` is `true`.
Method	matchAnyAppliedAssessmentPart
Description	Matches assessment parts with any applied assessment part.
Parameters	`boolean`	`match`	`true` to match assessment parts with any applied assessment part, `false` to match assessment parts with no applied assessment parts
Compliance	`mandatory`		This method must be implemented.
Method	clearAppliedAssessmentPartTerms
Description	Clears all assessment part terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBankId
Description	Matches constrainers 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	getSequenceRuleQueryRecord
Description	Gets the sequence rule query record corresponding to the given `SequenceRule` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`sequenceRuleRecordType`	a sequence rule record type
Return	`osid.assessment.authoring.records.SequenceRuleQueryRecord`		the sequence rule query record
Errors	NULL_ARGUMENT		`sequenceRuleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(sequenceRuleRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.