org.osid.assessment

Interface AssessmentTaken

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface AssessmentTaken
extends OsidObject

Represents a taken assessment or an assessment in progress.

Method Summary

Methods

Modifier and Type	Method and Description
DateTime	getActualStartTime() Gets the time this assessment was started.
AssessmentOffered	getAssessmentOffered() Gets the AssessmentOffered.
Id	getAssessmentOfferedId() Gets the Id of the AssessmentOffered.
AssessmentTakenRecord	getAssessmentTakenRecord(Type assessmentTakenRecordType) Gets the assessment taken record corresponding to the given AssessmentTaken record Type.
long	getCompletion() Gets a completion percentage of the assessment.
DateTime	getCompletionTime() Gets the time of this assessment was completed.
DisplayText	getFeedback() Gets any overall comments available for this assessment by the grader.
Grade	getGrade() Gets a grade for the assessment.
Id	getGradeId() Gets a grade Id for the assessment.
AssessmentTaken	getRubric() Gets the rubric.
Id	getRubricId() Gets the Id of the rubric.
java.math.BigDecimal	getScore() Gets a score for the assessment.
GradeSystem	getScoreSystem() Gets a grade system for the score.
Id	getScoreSystemId() Gets a score system Id for the assessment.
Resource	getTaker() Gets the Resource taking this assessment.
Id	getTakerId() Gets the Id of the resource who took or is taking this assessment.
Agent	getTakingAgent() Gets the Agent.
Id	getTakingAgentId() Gets the Id of the Agent who took or is taking the assessment.
Duration	getTimeSpent() Gets the total time spent taking this assessment.
boolean	hasEnded() Tests if this assessment has ended.
boolean	hasRubric() Tests if a rubric assessment is associated with this assessment.
boolean	hasStarted() Tests if this assessment has begun.
boolean	isGraded() Tests if a grade is available for this assessment.
boolean	isScored() Tests if a score is available for this assessment.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getAssessmentOfferedId

Id getAssessmentOfferedId()

Gets the Id of the AssessmentOffered.

Returns:

the assessment offered Id

Compliance:

mandatory - This method must be implemented.

getAssessmentOffered

AssessmentOffered getAssessmentOffered()
                                       throws OperationFailedException

Gets the AssessmentOffered.

Returns:

the assessment offered

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTakerId

Id getTakerId()

Gets the Id of the resource who took or is taking this assessment.

Returns:

the resource Id

Compliance:

mandatory - This method must be implemented.

getTaker

Resource getTaker()
                  throws OperationFailedException

Gets the Resource taking this assessment.

Returns:

the resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTakingAgentId

Id getTakingAgentId()

Gets the Id of the Agent who took or is taking the assessment.

Returns:

the agent Id

Compliance:

mandatory - This method must be implemented.

getTakingAgent

Agent getTakingAgent()
                     throws OperationFailedException

Gets the Agent.

Returns:

the agent

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasStarted

boolean hasStarted()

Tests if this assessment has begun.

Returns:

true if the assessment has begun, false otherwise

Compliance:

mandatory - This method must be implemented.

getActualStartTime

DateTime getActualStartTime()

Gets the time this assessment was started.

Returns:

the start time

Throws:

IllegalStateException - hasStarted() is false

Compliance:

mandatory - This method must be implemented.

hasEnded

boolean hasEnded()

Tests if this assessment has ended.

Returns:

true if the assessment has ended, false otherwise

Compliance:

mandatory - This method must be implemented.

getCompletionTime

DateTime getCompletionTime()

Gets the time of this assessment was completed.

Returns:

the end time

Throws:

IllegalStateException - hasEnded() is false

Compliance:

mandatory - This method must be implemented.

getTimeSpent

Duration getTimeSpent()

Gets the total time spent taking this assessment.

Returns:

the total time spent

Compliance:

mandatory - This method must be implemented.

getCompletion

long getCompletion()

Gets a completion percentage of the assessment.

Returns:

the percent complete (0-100)

Compliance:

mandatory - This method must be implemented.

isScored

boolean isScored()

Tests if a score is available for this assessment.

Returns:

true if a score is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getScoreSystemId

Id getScoreSystemId()

Gets a score system Id for the assessment.

Returns:

the grade system

Throws:

IllegalStateException - isScore() is false

Compliance:

mandatory - This method must be implemented.

getScoreSystem

GradeSystem getScoreSystem()
                           throws OperationFailedException

Gets a grade system for the score.

Returns:

the grade system

Throws:

IllegalStateException - isScored() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getScore

java.math.BigDecimal getScore()

Gets a score for the assessment.

Returns:

the score

Throws:

IllegalStateException - isScored() is false

Compliance:

mandatory - This method must be implemented.

isGraded

boolean isGraded()

Tests if a grade is available for this assessment.

Returns:

true if a grade is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeId

Id getGradeId()

Gets a grade Id for the assessment.

Returns:

the grade

Throws:

IllegalStateException - isGraded() is false

Compliance:

mandatory - This method must be implemented.

getGrade

Grade getGrade()
               throws OperationFailedException

Gets a grade for the assessment.

Returns:

the grade

Throws:

IllegalStateException - isGraded() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getFeedback

DisplayText getFeedback()

Gets any overall comments available for this assessment by the grader.

Returns:

comments

Compliance:

mandatory - This method must be implemented.

hasRubric

boolean hasRubric()

Tests if a rubric assessment is associated with this assessment.

Returns:

true if a rubric is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRubricId

Id getRubricId()

Gets the Id of the rubric.

Returns:

an assessment taken Id

Throws:

IllegalStateException - hasRubric() is false

Compliance:

mandatory - This method must be implemented.

getRubric

AssessmentTaken getRubric()
                          throws OperationFailedException

Gets the rubric.

Returns:

the assessment taken

Throws:

IllegalStateException - hasRubric() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssessmentTakenRecord

AssessmentTakenRecord getAssessmentTakenRecord(Type assessmentTakenRecordType)
                                               throws OperationFailedException

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:

assessmentTakenRecordType - an assessment taken record type

Returns:

the assessment taken record

Throws:

NullArgumentException - assessmentTakenRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentTakenRecordType) is false

Compliance:

mandatory - This method must be implemented.