Interface AssessmentTaken
- All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
Represents a taken assessment or an assessment in progress.
-
Method Summary
Modifier and TypeMethodDescriptionGets the time this assessment was started.Gets theAssessmentOffered.Gets theIdof theAssessmentOffered.getAssessmentTakenRecord(Type assessmentTakenRecordType) Gets the assessment taken record corresponding to the givenAssessmentTakenrecordType.longGets a completion percentage of the assessment.Gets the time of this assessment was completed.Gets any overall comments available for this assessment by the grader.getGrade()Gets a grade for the assessment.Gets a gradeIdfor the assessment.Gets the rubric.Gets theIdof the rubric.getScore()Gets a score for the assessment.Gets a grade system for the score.Gets a score systemIdfor the assessment.getTaker()Gets theResourcetaking this assessment.Gets theIdof the resource who took or is taking this assessment.Gets theAgent.Gets theIdof theAgentwho took or is taking the assessment.Gets the total time spent taking this assessment.booleanhasEnded()Tests if this assessment has ended.booleanTests if a rubric assessment is associated with this assessment.booleanTests if this assessment has begun.booleanisGraded()Tests if a grade is available for this assessment.booleanisScored()Tests if a score is available for this assessment.Methods inherited from interface Browsable
getProperties, getPropertiesByRecordTypeModifier and TypeMethodDescriptionGets a list of properties.getPropertiesByRecordType(Type recordType) Gets a list of properties corresponding to the specified record type.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusTypeModifier and TypeMethodDescriptionGets the description associated with this instance of this OSID object.Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.Gets the genus type of this object.booleanisOfGenusType(Type genusType) Tests if this object is of the given genusType.
-
Method Details
-
getAssessmentOfferedId
Id getAssessmentOfferedId()Gets theIdof theAssessmentOffered.- Returns:
- the assessment offered
Id - Compliance:
mandatory- This method must be implemented.
-
getAssessmentOffered
Gets theAssessmentOffered.- Returns:
- the assessment offered
- Throws:
OperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
getTakerId
Id getTakerId()Gets theIdof the resource who took or is taking this assessment.- Returns:
- the resource
Id - Compliance:
mandatory- This method must be implemented.
-
getTaker
Gets theResourcetaking this assessment.- Returns:
- the resource
- Throws:
OperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
getTakingAgentId
Id getTakingAgentId()Gets theIdof theAgentwho took or is taking the assessment.- Returns:
- the agent
Id - Compliance:
mandatory- This method must be implemented.
-
getTakingAgent
Gets theAgent.- 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:
trueif the assessment has begun,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getActualStartTime
DateTime getActualStartTime()Gets the time this assessment was started.- Returns:
- the start time
- Throws:
IllegalStateException-hasStarted()isfalse- Compliance:
mandatory- This method must be implemented.
-
hasEnded
boolean hasEnded()Tests if this assessment has ended.- Returns:
trueif the assessment has ended,falseotherwise- 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()isfalse- 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:
trueif a score is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getScoreSystemId
Id getScoreSystemId()Gets a score systemIdfor the assessment.- Returns:
- the grade system
- Throws:
IllegalStateException-isScore()isfalse- Compliance:
mandatory- This method must be implemented.
-
getScoreSystem
Gets a grade system for the score.- Returns:
- the grade system
- Throws:
IllegalStateException-isScored()isfalseOperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
getScore
BigDecimal getScore()Gets a score for the assessment.- Returns:
- the score
- Throws:
IllegalStateException-isScored()isfalse- Compliance:
mandatory- This method must be implemented.
-
isGraded
boolean isGraded()Tests if a grade is available for this assessment.- Returns:
trueif a grade is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getGradeId
Id getGradeId()Gets a gradeIdfor the assessment.- Returns:
- the grade
- Throws:
IllegalStateException-isGraded()isfalse- Compliance:
mandatory- This method must be implemented.
-
getGrade
Gets a grade for the assessment.- Returns:
- the grade
- Throws:
IllegalStateException-isGraded()isfalseOperationFailedException- 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:
trueif a rubric is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getRubricId
Id getRubricId()Gets theIdof the rubric.- Returns:
- an assessment taken
Id - Throws:
IllegalStateException-hasRubric()isfalse- Compliance:
mandatory- This method must be implemented.
-
getRubric
Gets the rubric.- Returns:
- the assessment taken
- Throws:
IllegalStateException-hasRubric()isfalseOperationFailedException- 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 givenAssessmentTakenrecordType. This method is used to retrieve an object implementing the requested record. TheassessmentTakenRecordTypemay be theTypereturned ingetRecordTypes()or any of its parents in aTypehierarchy wherehasRecordType(assessmentTakenRecordType)istrue.- Parameters:
assessmentTakenRecordType- an assessment taken record type- Returns:
- the assessment taken record
- Throws:
NullArgumentException-assessmentTakenRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(assessmentTakenRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-