Interface GradeEntryForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable
All Known Subinterfaces:
GradeEntryBatchForm
public interface GradeEntryForm extends OsidRelationshipForm

This is the form for creating and updating GradeEntries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the GradeEntryAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getIgnoredForCalculationsMetadata

      Metadata getIgnoredForCalculationsMetadata()
      Gets the metadata for the ignore flag.
      Returns:
      metadata for the ignore flag
      Compliance:
      mandatory - This method must be implemented.

    • setIgnoredForCalculations

      void setIgnoredForCalculations(boolean ignore)
      Sets the ignore for calculations flag.
      Parameters:
      ignore - the new ignore flag
      Throws:
      InvalidArgumentException - ignore is invalid
      NoAccessException - ignore cannot be modified
      Compliance:
      mandatory - This method must be implemented.

    • clearIgnoredForCalculations

      void clearIgnoredForCalculations()
      Clears the ignore for calculations flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGradeMetadata

      Metadata getGradeMetadata()
      Gets the metadata for a grade.
      Returns:
      metadata for the grade
      Compliance:
      mandatory - This method must be implemented.

    • setGrade

      void setGrade(Id gradeId)
      Sets the grade.
      Parameters:
      gradeId - the new grade
      Throws:
      InvalidArgumentException - gradeId is invalid or GradebookColumn.getGradeSystem().isBasedOnGrades() is false
      NoAccessException - gradeId cannot be modified
      NullArgumentException - gradeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearGrade

      void clearGrade()
      Clears the grade.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getScoreMetadata

      Metadata getScoreMetadata()
      Gets the metadata for a score.
      Returns:
      metadata for the score
      Compliance:
      mandatory - This method must be implemented.

    • setScore

      void setScore(BigDecimal score)
      Sets the score.
      Parameters:
      score - the new score
      Throws:
      InvalidArgumentException - score is invalid or GradebookColumn.getGradeSystem().isBasedOnGrades() is true
      NoAccessException - score cannot be modified
      Compliance:
      mandatory - This method must be implemented.

    • clearScore

      void clearScore()
      Clears the score.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGradeEntryFormRecord

      GradeEntryFormRecord getGradeEntryFormRecord(Type gradeEntryRecordType) throws OperationFailedException
      Gets the GradeEntryFormRecord corresponding to the given grade entry record Type.
      Parameters:
      gradeEntryRecordType - the grade entry record type
      Returns:
      the grade entry form record
      Throws:
      NullArgumentException - gradeEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(gradeEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.