Interface AssessmentEntry
- All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
An AssessmentEntry represents an academic record entry for an
assessment. It is intended to record standardized tests and other major
assessments associated with an academic record. Quizzes within a course
are tracked in the Grading OSID.
-
Method Summary
Modifier and TypeMethodDescriptionGets theAssessment.getAssessmentEntryRecord(Type assessmentEntryRecordType) Gets the assessment entry record corresponding to the givenAssessmentEntryrecordType.Gets theIdof theAssessment.Gets theCourse.Gets theIdof theCourse.Gets the completion date.getGrade()Gets theGrade.Gets theIdof theGrade.Gets theProgram.Gets theIdof theProgram.getScore()Gets the cumulative score.Gets theGradeSystem.Gets theIdof theGradeSystem.Gets theStudent.Gets theIdof theStudent.booleanTests if this assessment applies to a specific course.booleanhasGrade()Tests if a grade is available.booleanTests if this assessment applies to a program.booleanhasScore()Tests if a score is available.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.Methods inherited from interface OsidRelationship
getEndReason, getEndReasonId, hasEndReasonModifier and TypeMethodDescriptionGets a state indicating why this relationship has ended.Gets a stateIdindicating why this relationship has ended.booleanTests if a reason this relationship came to an end is known.Methods inherited from interface Temporal
getEndDate, getStartDate, isEffectiveModifier and TypeMethodDescriptionGets the end date.Gets the start date.booleanTests if the current date is within the start end end dates inclusive.
-
Method Details
-
getStudentId
Id getStudentId()Gets theIdof theStudent.- Returns:
- the student
Id - Compliance:
mandatory- This method must be implemented.
-
getStudent
Gets theStudent.- Returns:
- the student
- Throws:
OperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
getAssessmentId
Id getAssessmentId()Gets theIdof theAssessment.- Returns:
- the assessment
Id - Compliance:
mandatory- This method must be implemented.
-
getAssessment
Gets theAssessment.- Returns:
- the assessment
- Throws:
OperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
getDateCompleted
DateTime getDateCompleted()Gets the completion date.- Returns:
- the date completion
- Compliance:
mandatory- This method must be implemented.
-
hasProgram
boolean hasProgram()Tests if this assessment applies to a program. IfhasCourse()istruethenhasProgram()must befalse.- Returns:
trueif a program is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getProgramId
Id getProgramId()Gets theIdof theProgram.- Returns:
- the program
Id - Throws:
IllegalStateException-hasProgram()isfalse- Compliance:
mandatory- This method must be implemented.
-
getProgram
Gets theProgram.- Returns:
- the program
- Throws:
IllegalStateException-hasProgram()isfalseOperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
hasCourse
boolean hasCourse()Tests if this assessment applies to a specific course. IfhasCourse()istruethenhasProgram()must befalse.- Returns:
trueif a course is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getCourseId
Id getCourseId()Gets theIdof theCourse.- Returns:
- the course
Id - Throws:
IllegalStateException-hasCourse()isfalse- Compliance:
mandatory- This method must be implemented.
-
getCourse
Gets theCourse.- Returns:
- the course
- Throws:
IllegalStateException-hasCourse()isfalseOperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
hasGrade
boolean hasGrade()Tests if a grade is available.- Returns:
trueif a grade is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getGradeId
Id getGradeId()Gets theIdof theGrade.- Returns:
- the grade
Id - Throws:
IllegalStateException-hasGrade()isfalse- Compliance:
mandatory- This method must be implemented.
-
getGrade
Gets theGrade.- Returns:
- the grade
- Throws:
IllegalStateException-hasGrade()isfalseOperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
hasScore
boolean hasScore()Tests if a score is available.- Returns:
trueif a score is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getScoreScaleId
Id getScoreScaleId()Gets theIdof theGradeSystem.- Returns:
- the grade system
Id - Throws:
IllegalStateException-hasScore()isfalse- Compliance:
mandatory- This method must be implemented.
-
getScoreScale
Gets theGradeSystem.- Returns:
- the grade system
- Throws:
IllegalStateException-hasScore()isfalseOperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
getScore
BigDecimal getScore()Gets the cumulative score.- Returns:
- the score
- Throws:
IllegalStateException-hasScore()isfalse- Compliance:
mandatory- This method must be implemented.
-
getAssessmentEntryRecord
AssessmentEntryRecord getAssessmentEntryRecord(Type assessmentEntryRecordType) throws OperationFailedException Gets the assessment entry record corresponding to the givenAssessmentEntryrecordType. This method is used to retrieve an object implementing the requested record. TheassessmentEntryRecordTypemay be theTypereturned ingetRecordTypes()or any of its parents in aTypehierarchy wherehasRecordType(assessmentEntryRecordType)istrue.- Parameters:
assessmentEntryRecordType- the type of assessment entry record to retrieve- Returns:
- the assessment entry record
- Throws:
NullArgumentException-assessmentEntryRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(assessmentEntryRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-