Interface GradebookColumnCalculation

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule
public interface GradebookColumnCalculation extends OsidRule

A GradebookColumnCalculation represents a rule to derive a column baed on one or more other columns.

  • Method Details

    • getGradebookColumnId

      Id getGradebookColumnId()
      Gets the GradebookColumn Ids to which this column applies.
      Returns:
      the gradebook column Id
      Compliance:
      mandatory - This method must be implemented.

    • getGradebookColumn

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

    • getInputGradebookColumnIds

      IdList getInputGradebookColumnIds()
      Gets the GradebookColumn Ids from which this column is derived.
      Returns:
      the derived column Ids
      Compliance:
      mandatory - This method must be implemented.

    • getInputGradebookColumns

      GradebookColumnList getInputGradebookColumns() throws OperationFailedException
      Gets the GradebookColumns from which this column is derived.
      Returns:
      the derived columns
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getOperation

      CalculationOperation getOperation()
      Gets the operation to perform for deriving this column. The output of the operation determines the score or grade for the column entries.
      Returns:
      the calculation operation
      Compliance:
      mandatory - This method must be implemented.

    • getTweakedCenter

      BigDecimal getTweakedCenter()
      Gets the tweaked midpoint input value of the grading system for determining how to center calculated enries in this column. This tweak is applied before calculating standard deviation offsets for entries in this derived column.
      Returns:
      the tweaked center
      Throws:
      IllegalStateException - getCalculation() is not CalculationOperation.STD_DEVIATION_OFFSET
      Compliance:
      mandatory - This method must be implemented.

    • getTweakedStandardDeviation

      BigDecimal getTweakedStandardDeviation()
      Gets the tweaked standard deviation. This tweak is applied before calculating standard deviation offsets for entries in this derived column.
      Returns:
      the tweaked standard deviation
      Throws:
      IllegalStateException - getCalculation() is not CalculationOperation.STD_DEVIATION_OFFSET
      Compliance:
      mandatory - This method must be implemented.

    • getGradebookColumnCalculationRecord

      GradebookColumnCalculationRecord getGradebookColumnCalculationRecord(Type gradebookColumnCalculationRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the gradebook column calculation record corresponding to the given GradeBookColumnCalculation record Type . This method is used to retrieve an object implementing the requested record. The gradebookColumnCalculationRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(gradebookColumnCalculationRecordType) is true .
      Parameters:
      gradebookColumnCalculationRecordType - the type of the record to retrieve
      Returns:
      the gradebook column calculation record
      Throws:
      NullArgumentException - gradebookColumnCalculationRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - hasRecordType(gradebookColumnCalculationRecordType) is false
      Compliance:
      mandatory - This method must be implemented.