OSID - osid.assessment.AssessmentQuery Service Interface Definition

Interface	osid.assessment.AssessmentQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.assessment.AssessmentOfferedQuery`
	`osid.assessment.AssessmentQuery`
	`osid.assessment.AssessmentQuerySession`
	`osid.assessment.AssessmentSearchSession`
	`osid.assessment.AssessmentSmartBankSession`
	`osid.assessment.BankQuery`
	`osid.assessment.ItemQuery`
	`osid.assessment.authoring.AssessmentPartQuery`
	`osid.course.chronicle.AssessmentEntryQuery`
	`osid.course.chronicle.AwardEntryQuery`
	show 4 more…
`osid.course.requisite.RequisiteQuery`
`osid.course.syllabus.DocetQuery`
`osid.learning.ActivityQuery`
`osid.learning.ObjectiveQuery`
Description	This is the query for searching assessments. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR`.
Method	matchLevelId
Description	Sets the level grade `Id` for this query.
Parameters	`osid.id.Id`	`gradeId`	a grade `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLevelIdTerms
Description	Clears all level `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLevelQuery
Description	Tests if a `GradeQuery` is available.
Return	`boolean`		`true` if a grade query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLevelQuery
Description	Gets the query for a grade. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeQuery`		the grade query
Errors	UNIMPLEMENTED		`supportsLevelQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLevelQuery()` is `true`.
Method	matchAnyLevel
Description	Matches an assessment that has any level assigned.
Parameters	`boolean`	`match`	`true` to match assessments with any level, `false` to match assessments with no level
Compliance	`mandatory`		This method must be implemented.
Method	clearLevelTerms
Description	Clears all level terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRubricId
Description	Sets the rubric assessment `Id` for this query.
Parameters	`osid.id.Id`	`assessmentId`	an assessment `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRubricIdTerms
Description	Clears all rubric assessment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRubricQuery
Description	Tests if an `AssessmentQuery` is available.
Return	`boolean`		`true` if a rubric assessment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRubricQuery
Description	Gets the query for a rubric assessment. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.AssessmentQuery`		the assessment query
Errors	UNIMPLEMENTED		`supportsRubricQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRubricQuery()` is `true`.
Method	matchAnyRubric
Description	Matches an assessment that has any rubric assessment assigned.
Parameters	`boolean`	`match`	`true` to match assessments with any rubric, `false` to match assessments with no rubric
Compliance	`mandatory`		This method must be implemented.
Method	clearRubricTerms
Description	Clears all rubric assessment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchItemId
Description	Sets the item `Id` for this query.
Parameters	`osid.id.Id`	`itemId`	an item `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`itemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearItemIdTerms
Description	Clears all item `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemQuery
Description	Tests if an `ItemQuery` is available.
Return	`boolean`		`true` if an item query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getItemQuery
Description	Gets the query for an item. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.ItemQuery`		the item query
Errors	UNIMPLEMENTED		`supportsItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemQuery()` is `true`.
Method	matchAnyItem
Description	Matches an assessment that has any item.
Parameters	`boolean`	`match`	`true` to match assessments with any item, `false` to match assessments with no items
Compliance	`mandatory`		This method must be implemented.
Method	clearItemTerms
Description	Clears all item terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAssessmentOfferedId
Description	Sets the assessment offered `Id` for this query.
Parameters	`osid.id.Id`	`assessmentOfferedId`	an assessment offered `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentOfferedId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentOfferedIdTerms
Description	Clears all assessment offered `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentOfferedQuery
Description	Tests if an `AssessmentOfferedQuery` is available.
Return	`boolean`		`true` if an assessment offered query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentOfferedQuery
Description	Gets the query for an assessment offered. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.AssessmentOfferedQuery`		the assessment offered query
Errors	UNIMPLEMENTED		`supportsAssessmentOfferedQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssessmentOfferedQuery()` is `true`.
Method	matchAnyAssessmentOffered
Description	Matches an assessment that has any offering.
Parameters	`boolean`	`match`	`true` to match assessments with any offering, `false` to match assessments with no offerings
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentOfferedTerms
Description	Clears all assessment offered terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAssessmentTakenId
Description	Sets the assessment taken `Id` for this query.
Parameters	`osid.id.Id`	`assessmentTakenId`	an assessment taken `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentTakenId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentTakenIdTerms
Description	Clears all assessment taken `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentTakenQuery
Description	Tests if an `AssessmentTakenQuery` is available.
Return	`boolean`		`true` if an assessment taken query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentTakenQuery
Description	Gets the query for an assessment taken. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.AssessmentTakenQuery`		the assessment taken query
Errors	UNIMPLEMENTED		`supportsAssessmentTakenQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssessmentTakenQuery()` is `true`.
Method	matchAnyAssessmentTaken
Description	Matches an assessment that has any taken version.
Parameters	`boolean`	`match`	`true` to match assessments with any taken assessments, `false` to match assessments with no taken assessments
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentTakenTerms
Description	Clears all assessment taken terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBankId
Description	Sets the bank `Id` for this query.
Parameters	`osid.id.Id`	`bankId`	a 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 all bank `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBankQuery
Description	Tests if a `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 all bank terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentQueryRecord
Description	Gets the assessment query record corresponding to the given `Assessment` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`assessmentRecordType`	an assessment record type
Return	`osid.assessment.records.AssessmentQueryRecord`		the assessment query record
Errors	NULL_ARGUMENT		`assessmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assessmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.