OSID - osid.assessment.AssessmentTaken Service Interface Definition

Interface	osid.assessment.AssessmentTaken
Implements	`osid.OsidObject`
Used By	`osid.assessment.AssessmentSection`
	`osid.assessment.AssessmentTaken`
	`osid.assessment.AssessmentTakenAdminSession`
	`osid.assessment.AssessmentTakenList`
	`osid.assessment.AssessmentTakenLookupSession`
Description	Represents a taken assessment or an assessment in progress.
Method	getAssessmentOfferedId
Description	Gets the `Id` of the `AssessmentOffered`.
Return	`osid.id.Id`		the assessment offered `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentOffered
Description	Gets the `AssessmentOffered`.
Return	`osid.assessment.AssessmentOffered`		the assessment offered
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTakerId
Description	Gets the `Id` of the resource who took or is taking this assessment.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getTaker
Description	Gets the `Resource` taking this assessment.
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTakingAgentId
Description	Gets the `Id` of the `Agent` who took or is taking the assessment.
Return	`osid.id.Id`		the agent `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getTakingAgent
Description	Gets the `Agent`.
Return	`osid.authentication.Agent`		the agent
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasStarted
Description	Tests if this assessment has begun.
Return	`boolean`		`true` if the assessment has begun, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActualStartTime
Description	Gets the time this assessment was started.
Return	`osid.calendaring.DateTime`		the start time
Errors	ILLEGAL_STATE		`hasStarted()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasEnded
Description	Tests if this assessment has ended.
Return	`boolean`		`true` if the assessment has ended, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompletionTime
Description	Gets the time of this assessment was completed.
Return	`osid.calendaring.DateTime`		the end time
Errors	ILLEGAL_STATE		`hasEnded()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeSpent
Description	Gets the total time spent taking this assessment.
Return	`osid.calendaring.Duration`		the total time spent
Compliance	`mandatory`		This method must be implemented.
Method	getCompletion
Description	Gets a completion percentage of the assessment.
Return	`cardinal`		the percent complete (0-100)
Compliance	`mandatory`		This method must be implemented.
Method	isScored
Description	Tests if a score is available for this assessment.
Return	`boolean`		`true` if a score is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getScoreSystemId
Description	Gets a score system `Id` for the assessment.
Return	`osid.id.Id`		the grade system
Errors	ILLEGAL_STATE		`isScore()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getScoreSystem
Description	Gets a grade system for the score.
Return	`osid.grading.GradeSystem`		the grade system
Errors	ILLEGAL_STATE		`isScored()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getScore
Description	Gets a score for the assessment.
Return	`decimal`		the score
Errors	ILLEGAL_STATE		`isScored()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isGraded
Description	Tests if a grade is available for this assessment.
Return	`boolean`		`true` if a grade is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeId
Description	Gets a grade `Id` for the assessment.
Return	`osid.id.Id`		the grade
Errors	ILLEGAL_STATE		`isGraded()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getGrade
Description	Gets a grade for the assessment.
Return	`osid.grading.Grade`		the grade
Errors	ILLEGAL_STATE		`isGraded()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getFeedback
Description	Gets any overall comments available for this assessment by the grader.
Return	`osid.locale.DisplayText`		comments
Compliance	`mandatory`		This method must be implemented.
Method	hasRubric
Description	Tests if a rubric assessment is associated with this assessment.
Return	`boolean`		`true` if a rubric is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRubricId
Description	Gets the `Id` of the rubric.
Return	`osid.id.Id`		an assessment taken `Id`
Errors	ILLEGAL_STATE		`hasRubric()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRubric
Description	Gets the rubric.
Return	`osid.assessment.AssessmentTaken`		the assessment taken
Errors	ILLEGAL_STATE		`hasRubric()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentTakenRecord
Description	Gets the assessment taken record corresponding to the given `AssessmentTaken` record `Type`. This method is used to retrieve an object implementing the requested record. The `assessmentTakenRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(assessmentTakenRecordType)` is `true`.
Parameters	`osid.type.Type`	`assessmentTakenRecordType`	an assessment taken record type
Return	`osid.assessment.records.AssessmentTakenRecord`		the assessment taken 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.