Interface GradeEntry

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface GradeEntry extends OsidRelationship

A GradeEntry represents an entry in a Gradebook .

  • Method Details

    • getGradebookColumnId

      Id getGradebookColumnId()
      Gets the Id of the GradebookColumn .
      Returns:
      the Id of the GradebookColumn
      Compliance:
      mandatory - This method must be implemented.

    • getGradebookColumn

      GradebookColumn getGradebookColumn() throws OperationFailedException
      Gets the GradebookColumn .
      Returns:
      the GradebookColumn
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getKeyResourceId

      Id getKeyResourceId()
      Gets the Id of the key resource of this entry. The key resource may be a student or other applicable key to identify a row of grading entries.
      Returns:
      Id of the key resource
      Compliance:
      mandatory - This method must be implemented.

    • getKeyResource

      Resource getKeyResource() throws OperationFailedException
      Gets the key resource of this entry. The key resource may be a student or other applicable key to identify a row of grading entries.
      Returns:
      the key resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isDerived

      boolean isDerived()
      Tests if this is a calculated entry.
      Returns:
      true if this entry is a calculated entry, false otherwise. If true , then overridesCalculatedEntry() must be false .
      Compliance:
      mandatory - This method must be implemented.

    • overridesCalculatedEntry

      boolean overridesCalculatedEntry()
      Tests if this is a manual entry that overrides a calculated entry.
      Returns:
      true if this entry overrides a calculated entry, false otherwise. If true , then isDerived() must be false .
      Compliance:
      mandatory - This method must be implemented.

    • getOverriddenCalculatedEntryId

      Id getOverriddenCalculatedEntryId()
      Gets the calculated entry Id this entry overrides.
      Returns:
      the calculated entry Id
      Throws:
      IllegalStateException - overridesDerivedEntry() is false
      Compliance:
      mandatory - This method must be implemented.

    • getOverriddenCalculatedEntry

      GradeEntry getOverriddenCalculatedEntry() throws OperationFailedException
      Gets the calculated entry this entry overrides.
      Returns:
      the calculated entry
      Throws:
      IllegalStateException - overridesCalculatedEntry() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isIgnoredForCalculations

      boolean isIgnoredForCalculations()
      Tests if this is entry should be ignored in any averaging, scaling or curve calculation.
      Returns:
      true if this entry is ignored, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • isGraded

      boolean isGraded()
      Tests if a grade or score has been assigned to this entry. Generally, an entry is created with a grade or score.
      Returns:
      true if a grade has been assigned, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradeId

      Id getGradeId()
      Gets the grade Id in this entry if the grading system is based on grades.
      Returns:
      the grade Id
      Throws:
      IllegalStateException - isGraded() is false or GradeSystem.isBasedOnGrades() is false
      Compliance:
      mandatory - This method must be implemented.

    • getGrade

      Grade getGrade() throws OperationFailedException
      Gets the grade in this entry if the grading system is based on grades.
      Returns:
      the grade
      Throws:
      IllegalStateException - isGraded() is false or GradeSystem.isBasedOnGrades() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getScore

      BigDecimal getScore()
      Gets the score in this entry if the grading system is not based on grades.
      Returns:
      the score
      Throws:
      IllegalStateException - isGraded() is false or GradeSystem.isBasedOnGrades() is true
      Compliance:
      mandatory - This method must be implemented.

    • getTimeGraded

      DateTime getTimeGraded()
      Gets the time the gradeable object was graded.
      Returns:
      the timestamp of the grading entry
      Throws:
      IllegalStateException - isGraded() is false or isDerived() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGraderId

      Id getGraderId()
      Gets the Id of the Resource that created this entry.
      Returns:
      the Id of the Resource
      Throws:
      IllegalStateException - isGraded() is false or isDerived() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGrader

      Resource getGrader() throws OperationFailedException
      Gets the Resource that created this entry.
      Returns:
      the Resource
      Throws:
      IllegalStateException - isGraded() is false or isDerived() is true
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getGradingAgentId

      Id getGradingAgentId()
      Gets the Id of the Agent that created this entry.
      Returns:
      the Id of the Agent
      Throws:
      IllegalStateException - isGraded() is false or isDerived() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGradingAgent

      Agent getGradingAgent() throws OperationFailedException
      Gets the Agent that created this entry.
      Returns:
      the Agent
      Throws:
      IllegalStateException - isGraded() is false or isDerived() is true
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getGradeEntryRecord

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