OSID - osid.assessment.AssessmentTakenQuery Service Interface Definition

Interface	osid.assessment.AssessmentTakenQuery
Implements	`osid.OsidObjectQuery`
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	matchAssessmentOfferedId
Description	Sets the assessment offered `Id` for this query.
Parameters	`osid.id.Id`	`assessmentOfferedId`	an assessment `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. 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	clearAssessmentOfferedTerms
Description	Clears all assessment offered terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTakerId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTakerIdTerms
Description	Clears all resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTakerQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTakerQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsTakerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTakerQuery()` is `true.`
Method	clearTakerTerms
Description	Clears all resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTakingAgentId
Description	Sets the agent `Id` for this query.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTakingAgentIdTerms
Description	Clears all agent `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTakingAgentQuery
Description	Tests if an `AgentQuery` is available.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTakingAgentQuery
Description	Gets the query for an agent. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsTakingAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTakingAgentQuery()` is `true.`
Method	clearTakingAgentTerms
Description	Clears all taking agent terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActualStartTime
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`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyActualStartTime
Description	Matches taken assessments taken that have begun.
Parameters	`boolean`	`match`	`true` to match assessments taken started, `false` to match assessments taken that have not begun
Compliance	`mandatory`		This method must be implemented.
Method	clearActualStartTimeTerms
Description	Clears all start time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCompletionTime
Description	Matches assessments whose completion 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	matchAnyCompletionTime
Description	Matches taken assessments taken that have completed.
Parameters	`boolean`	`match`	`true` to match assessments taken completed, `false` to match assessments taken that are incomplete
Compliance	`mandatory`		This method must be implemented.
Method	clearCompletionTimeTerms
Description	Clears all in completion time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimeSpent
Description	Matches assessments where the time spent falls between the specified range inclusive.
Parameters	`osid.calendaring.Duration`	`low`	start of duration range
	`osid.calendaring.Duration`	`high`	end of duration range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeSpentTerms
Description	Clears all in time spent 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	matchScore
Description	Matches assessments whose score falls between the specified range inclusive.
Parameters	`decimal`	`low`	start of range
	`decimal`	`high`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyScore
Description	Matches taken assessments that have any score assigned.
Parameters	`boolean`	`match`	`true` to match assessments with any score, `false` to match assessments with no score
Compliance	`mandatory`		This method must be implemented.
Method	clearScoreTerms
Description	Clears all score terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGradeId
Description	Sets the 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	clearGradeIdTerms
Description	Clears all grade `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeQuery
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	getGradeQuery
Description	Gets the query for a grade. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeQuery`		the grade query
Errors	UNIMPLEMENTED		`supportsGradeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradeQuery()` is `true.`
Method	matchAnyGrade
Description	Matches taken assessments that have any grade assigned.
Parameters	`boolean`	`match`	`true` to match assessments with any grade, `false` to match assessments with no grade
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeTerms
Description	Clears all grade terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFeedback
Description	Sets the comment string for this query.
Parameters	`string`	`comments`	comment string
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`comments is` not of `stringMatchType`
	NULL_ARGUMENT		`comments` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyFeedback
Description	Matches taken assessments that have any comments.
Parameters	`boolean`	`match`	`true` to match assessments with any comments, `false` to match assessments with no comments
Compliance	`mandatory`		This method must be implemented.
Method	clearFeedbackTerms
Description	Clears all comment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRubricId
Description	Sets the rubric 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	clearRubricIdTerms
Description	Clears all rubric assessment taken `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRubricQuery
Description	Tests if an `AssessmentTakenQuery` is available.
Return	`boolean`		`true` if a rubric assessment taken 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.AssessmentTakenQuery`		the assessment taken query
Errors	UNIMPLEMENTED		`supportsRubricQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRubricQuery()` is `true.`
Method	matchAnyRubric
Description	Matches an assessment taken that has any rubric assessment assigned.
Parameters	`boolean`	`match`	`true` to match assessments taken with any rubric, `false` to match assessments taken with no rubric
Compliance	`mandatory`		This method must be implemented.
Method	clearRubricTerms
Description	Clears all rubric 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	getAssessmentTakenQueryRecord
Description	Gets the assessment taken query record corresponding to the given `AssessmentTaken` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`assessmentTakenRecordType`	an assessment taken record type
Return	`osid.assessment.records.AssessmentTakenQueryRecord`		the assessment taken query record
Errors	NULL_ARGUMENT		`assessmentTakenRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assessmentTakenRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.