Interface GradebookColumnSummary

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface GradebookColumnSummary extends OsidObject

A GradebookColumnSummary is a summary of all entries within a gradebook column.

  • 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.

    • getMean

      BigDecimal getMean()
      Gets the mean score. If this system is based on grades, the mean output score is returned.
      Returns:
      the mean score
      Compliance:
      mandatory - This method must be implemented.

    • getMedian

      BigDecimal getMedian()
      Gets the median score. If this system is based on grades, the mean output score is returned.
      Returns:
      the median score
      Compliance:
      mandatory - This method must be implemented.

    • getMode

      BigDecimal getMode()
      Gets the mode of the score. If this system is based on grades, the mode of the output score is returned.
      Returns:
      the median score
      Compliance:
      mandatory - This method must be implemented.

    • getRMS

      BigDecimal getRMS()
      Gets the root mean square of the score. If this system is based on grades, the RMS of the output score is returned.
      Returns:
      the median score
      Compliance:
      mandatory - This method must be implemented.

    • getStandardDeviation

      BigDecimal getStandardDeviation()
      Gets the standard deviation. If this system is based on grades, the spread of the output scores is returned.
      Returns:
      the standard deviation
      Compliance:
      mandatory - This method must be implemented.

    • getSum

      BigDecimal getSum()
      Gets the sum of the scores. If this system is based on grades, the sum of the output scores is returned.
      Returns:
      the median score
      Compliance:
      mandatory - This method must be implemented.

    • getGradebookColumnSummaryRecord

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