OSID - osid.assessment.AssessmentOfferedQuery Service Interface Definition

Interface	osid.assessment.AssessmentOfferedQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.assessment.AssessmentOfferedQuery`
	`osid.assessment.AssessmentOfferedQuerySession`
	`osid.assessment.AssessmentOfferedSearchSession`
	`osid.assessment.AssessmentOfferedSmartBankSession`
	`osid.assessment.AssessmentQuery`
	`osid.assessment.AssessmentTakenQuery`
	`osid.assessment.BankQuery`
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	matchAssessmentId
Description	Sets the 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	clearAssessmentIdTerms
Description	Clears all assessment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentQuery
Description	Tests if an `AssessmentQuery` is available.
Return	`boolean`		`true` if an assessment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentQuery
Description	Gets the query for an assessment. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.AssessmentQuery`		the assessment query
Errors	UNIMPLEMENTED		`supportsAssessmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssessmentQuery()` is `true`.
Method	clearAssessmentTerms
Description	Clears all assessment terms.
Compliance	`mandatory`		This method must be implemented.
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 offered that has any level assigned.
Parameters	`boolean`	`match`	`true` to match offerings with any level, `false` to match offerings with no levsls
Compliance	`mandatory`		This method must be implemented.
Method	clearLevelTerms
Description	Clears all level terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchItemsSequential
Description	Match sequential assessments.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearItemsSequentialTerms
Description	Clears all sequential terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchItemsShuffled
Description	Match shuffled item assessments.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearItemsShuffledTerms
Description	Clears all shuffled terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStartTime
Description	Matches assessments whose start time falls between the specified range inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of range
	`osid.calendaring.DateTime`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyStartTime
Description	Matches offerings that has any start time assigned.
Parameters	`boolean`	`match`	`true` to match offerings with any start time, `false` to match offerings with no start time
Compliance	`mandatory`		This method must be implemented.
Method	clearStartTimeTerms
Description	Clears all scheduled terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDeadline
Description	Matches assessments whose end time falls between the specified range inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of range
	`osid.calendaring.DateTime`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDeadline
Description	Matches offerings that have any deadline assigned.
Parameters	`boolean`	`match`	`true` to match offerings with any deadline, `false` to match offerings with no deadline
Compliance	`mandatory`		This method must be implemented.
Method	clearDeadlineTerms
Description	Clears all deadline terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDuration
Description	Matches assessments whose duration falls between the specified range inclusive.
Parameters	`osid.calendaring.Duration`	`low`	start range of duration
	`osid.calendaring.Duration`	`high`	end range of duration
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDuration
Description	Matches offerings that have any duration assigned.
Parameters	`boolean`	`match`	`true` to match offerings with any duration, `false` to match offerings with no duration
Compliance	`mandatory`		This method must be implemented.
Method	clearDurationTerms
Description	Clears all duration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchScoreSystemId
Description	Sets the grade system `Id` for this query.
Parameters	`osid.id.Id`	`gradeSystemId`	a grade system `Id`
Parameters	`boolean`	`match`	`true for a positive match, false for a negative match`
Errors	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearScoreSystemIdTerms
Description	Clears all grade system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsScoreSystemQuery
Description	Tests if a `GradeSystemQuery` is available.
Return	`boolean`		`true` if a grade system query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getScoreSystemQuery
Description	Gets the query for a grade system. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeSystemQuery`		the grade system query
Errors	UNIMPLEMENTED		`supportsScoreSystemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsScoreSystemQuery()` is `true`.
Method	matchAnyScoreSystem
Description	Matches taken assessments that have any grade system assigned.
Parameters	`boolean`	`match`	`true` to match assessments with any grade system, `false` to match assessments with no grade system
Compliance	`mandatory`		This method must be implemented.
Method	clearScoreSystemTerms
Description	Clears all grade system terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGradeSystemId
Description	Sets the grade system `Id` for this query.
Parameters	`osid.id.Id`	`gradeSystemId`	a grade system `Id`
Parameters	`boolean`	`match`	`true for a positive match, false for a negative match`
Errors	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeSystemIdTerms
Description	Clears all grade system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemQuery
Description	Tests if a `GradeSystemQuery` is available.
Return	`boolean`		`true` if a grade system query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemQuery
Description	Gets the query for a grade system. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeSystemQuery`		the grade system query
Errors	UNIMPLEMENTED		`supportsScoreSystemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsScoreSystemQuery()` is `true`.
Method	matchAnyGradeSystem
Description	Matches taken assessments that have any grade system assigned.
Parameters	`boolean`	`match`	`true` to match assessments with any grade system, `false` to match assessments with no grade system
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeSystemTerms
Description	Clears all grade system terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRubricId
Description	Sets the rubric 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	clearRubricIdTerms
Description	Clears all rubric assessment offered `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRubricQuery
Description	Tests if an `AssessmentOfferedQuery` is available.
Return	`boolean`		`true` if a rubric assessment offered 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.AssessmentOfferedQuery`		the assessment offered query
Errors	UNIMPLEMENTED		`supportsRubricQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRubricQuery()` is `true`.
Method	matchAnyRubric
Description	Matches an assessment offered that has any rubric assessment assigned.
Parameters	`boolean`	`match`	`true` to match assessments offered with any rubric, `false` to match assessments offered 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	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 offerings that have any taken assessment version.
Parameters	`boolean`	`match`	`true` to match offerings with any taken assessment, `false` to match offerings with no assessmen taken
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	getAssessmentOfferedQueryRecord
Description	Gets the assessment offered query record corresponding to the given `AssessmentOffered` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`assessmentOfferedRecordType`	an assessment offered record type
Return	`osid.assessment.records.AssessmentOfferedQueryRecord`		the assessment offered query record
Errors	NULL_ARGUMENT		`assessmentOfferedRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assessmentOfferedRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.