Interface AssessmentEntry

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface AssessmentEntry extends OsidRelationship

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 Details

    • getStudentId

      Id getStudentId()
      Gets the Id of the Student .
      Returns:
      the student Id
      Compliance:
      mandatory - This method must be implemented.
    • getStudent

      Resource getStudent() throws OperationFailedException
      Gets the Student .
      Returns:
      the student
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.
    • getAssessmentId

      Id getAssessmentId()
      Gets the Id of the Assessment .
      Returns:
      the assessment Id
      Compliance:
      mandatory - This method must be implemented.
    • getAssessment

      Assessment getAssessment() throws OperationFailedException
      Gets the Assessment .
      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. If hasCourse() is true then hasProgram() must be false .
      Returns:
      true if a program is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • getProgramId

      Id getProgramId()
      Gets the Id of the Program .
      Returns:
      the program Id
      Throws:
      IllegalStateException - hasProgram() is false
      Compliance:
      mandatory - This method must be implemented.
    • getProgram

      Program getProgram() throws OperationFailedException
      Gets the Program .
      Returns:
      the program
      Throws:
      IllegalStateException - hasProgram() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.
    • hasCourse

      boolean hasCourse()
      Tests if this assessment applies to a specific course. If hasCourse() is true then hasProgram() must be false .
      Returns:
      true if a course is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • getCourseId

      Id getCourseId()
      Gets the Id of the Course .
      Returns:
      the course Id
      Throws:
      IllegalStateException - hasCourse() is false
      Compliance:
      mandatory - This method must be implemented.
    • getCourse

      Course getCourse() throws OperationFailedException
      Gets the Course .
      Returns:
      the course
      Throws:
      IllegalStateException - hasCourse() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.
    • hasGrade

      boolean hasGrade()
      Tests if a grade is available.
      Returns:
      true if a grade is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • getGradeId

      Id getGradeId()
      Gets the Id of the Grade .
      Returns:
      the grade Id
      Throws:
      IllegalStateException - hasGrade() is false
      Compliance:
      mandatory - This method must be implemented.
    • getGrade

      Grade getGrade() throws OperationFailedException
      Gets the Grade .
      Returns:
      the grade
      Throws:
      IllegalStateException - hasGrade() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.
    • hasScore

      boolean hasScore()
      Tests if a score is available.
      Returns:
      true if a score is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.
    • getScoreScaleId

      Id getScoreScaleId()
      Gets the Id of the GradeSystem .
      Returns:
      the grade system Id
      Throws:
      IllegalStateException - hasScore() is false
      Compliance:
      mandatory - This method must be implemented.
    • getScoreScale

      GradeSystem getScoreScale() throws OperationFailedException
      Gets the GradeSystem .
      Returns:
      the grade system
      Throws:
      IllegalStateException - hasScore() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.
    • getScore

      BigDecimal getScore()
      Gets the cumulative score.
      Returns:
      the score
      Throws:
      IllegalStateException - hasScore() is false
      Compliance:
      mandatory - This method must be implemented.
    • getAssessmentEntryRecord

      AssessmentEntryRecord getAssessmentEntryRecord(Type assessmentEntryRecordType) throws OperationFailedException
      Gets the assessment entry record corresponding to the given AssessmentEntry record Type . This method is used to retrieve an object implementing the requested record. The assessmentEntryRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(assessmentEntryRecordType) is true .
      Parameters:
      assessmentEntryRecordType - the type of assessment entry record to retrieve
      Returns:
      the assessment entry record
      Throws:
      NullArgumentException - assessmentEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(assessmentEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.