Interface GradeEntrySearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface GradeEntrySearchOrder extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByGradebookColumn

      void orderByGradebookColumn(SearchOrderStyle style)
      Specified a preference for ordering results by the gradebook column.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsGradebookColumnSearchOrder

      boolean supportsGradebookColumnSearchOrder()
      Tests if a GradebookColumnSearchOrder is available.
      Returns:
      true if a gradebook column search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradebookColumnSearchOrder

      GradebookColumnSearchOrder getGradebookColumnSearchOrder()
      Gets the search order for a gradebook column.
      Returns:
      the gradebook column search order
      Throws:
      UnimplementedException - supportsGradebookColumnSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradebookColumnSearchOrder()} is {@code true} .

    • orderByKeyResource

      void orderByKeyResource(SearchOrderStyle style)
      Specified a preference for ordering results by the key resource.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsKeyResourceSearchOrder

      boolean supportsKeyResourceSearchOrder()
      Tests if a ResourceSearchOrder is available.
      Returns:
      true if a key resource search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getKeyResourceSearchOrder

      ResourceSearchOrder getKeyResourceSearchOrder()
      Gets the search order for a resource.
      Returns:
      the key resource search order
      Throws:
      UnimplementedException - supportsKeyResourceSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsKeyResourceSearchOrder()} is {@code true} .

    • orderByDerived

      void orderByDerived(SearchOrderStyle style)
      Specified a preference for ordering results by the derived entries.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByIgnoredForCalculations

      void orderByIgnoredForCalculations(SearchOrderStyle style)
      Specified a preference for ordering results by the ignore for calculations flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByGrade

      void orderByGrade(SearchOrderStyle style)
      Specified a preference for ordering results by the grade or score.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsGradeSearchOrder

      boolean supportsGradeSearchOrder()
      Tests if a GradeSearchOrder is available.
      Returns:
      true if a grade search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradeSearchOrder

      GradeSearchOrder getGradeSearchOrder()
      Gets the search order for a grade.
      Returns:
      the grade search order
      Throws:
      UnimplementedException - supportsGradeSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSearchOrder()} is {@code true} .

    • orderByTimeGraded

      void orderByTimeGraded(SearchOrderStyle style)
      Specified a preference for ordering results by the time graded.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByGrader

      void orderByGrader(SearchOrderStyle style)
      Specified a preference for ordering results by the grader.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsGraderSearchOrder

      boolean supportsGraderSearchOrder()
      Tests if a ResourceSearchOrder is available for grader resources.
      Returns:
      true if a resource search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGraderSearchOrder

      ResourceSearchOrder getGraderSearchOrder()
      Gets the search order for a grader.
      Returns:
      the resource search order
      Throws:
      UnimplementedException - supportsGraderSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGraderSearchOrder()} is {@code true} .

    • orderByGradingAgent

      void orderByGradingAgent(SearchOrderStyle style)
      Specified a preference for ordering results by the grading agent.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsGradingAgentSearchOrder

      boolean supportsGradingAgentSearchOrder()
      Tests if an AgentSearchOrder is available fo grading agents.
      Returns:
      true if an agent search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradingAgentSearchOrder

      AgentSearchOrder getGradingAgentSearchOrder()
      Gets the search order for a grading agent.
      Returns:
      the agent search order
      Throws:
      UnimplementedException - supportsGradingAgentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradingAgentSearchOrder()} is {@code true} .

    • getGradeEntrySearchOrderRecord

      GradeEntrySearchOrderRecord getGradeEntrySearchOrderRecord(Type gradeEntryRecordType) throws OperationFailedException
      Gets the grade entry search order record corresponding to the given grade entry record Type .Multiple retrievals return the same underlying object.
      Parameters:
      gradeEntryRecordType - a grade entry record type
      Returns:
      the grade entry search order record
      Throws:
      NullArgumentException - gradeEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(gradeEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.