Interface GradeForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable
All Known Subinterfaces:
GradeBatchForm
public interface GradeForm extends OsidObjectForm, OsidSubjugateableForm

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

  • Method Details

    • getInputScoreStartRangeMetadata

      Metadata getInputScoreStartRangeMetadata()
      Gets the metadata for the input score start range.
      Returns:
      metadata for the input score start range
      Compliance:
      mandatory - This method must be implemented.

    • setInputScoreStartRange

      void setInputScoreStartRange(BigDecimal score)
      Sets the input score start range.
      Parameters:
      score - the new start range
      Throws:
      InvalidArgumentException - score is invalid
      NoAccessException - range cannot be modified
      Compliance:
      mandatory - This method must be implemented.

    • clearInputScoreStartRange

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

    • getInputScoreEndRangeMetadata

      Metadata getInputScoreEndRangeMetadata()
      Gets the metadata for the input score start range.
      Returns:
      metadata for the input score start range
      Compliance:
      mandatory - This method must be implemented.

    • setInputScoreEndRange

      void setInputScoreEndRange(BigDecimal score)
      Sets the input score start range.
      Parameters:
      score - the new start range
      Throws:
      InvalidArgumentException - score is invalid
      NoAccessException - range cannot be modified
      Compliance:
      mandatory - This method must be implemented.

    • clearInputScoreEndRange

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

    • getOutputScoreMetadata

      Metadata getOutputScoreMetadata()
      Gets the metadata for the output score start range.
      Returns:
      metadata for the output score start range
      Compliance:
      mandatory - This method must be implemented.

    • setOutputScore

      void setOutputScore(BigDecimal score)
      Sets the output score.
      Parameters:
      score - the new output score
      Throws:
      InvalidArgumentException - score is invalid
      NoAccessException - score cannot be modified
      Compliance:
      mandatory - This method must be implemented.

    • clearOutputScore

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

    • getGradeFormRecord

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