Interface ObjectiveSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable
public interface ObjectiveSearchOrder extends OsidObjectSearchOrder, OsidFederateableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByAssessment

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

    • supportsAssessmentSearchOrder

      boolean supportsAssessmentSearchOrder()
      Tests if an AssessmentSearchOrder is available.
      Returns:
      true if an assessment search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentSearchOrder

      AssessmentSearchOrder getAssessmentSearchOrder()
      Gets the search order for an assessment.
      Returns:
      the assessment search order
      Throws:
      UnimplementedException - supportsAssessmentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAssessmentSearchOrder()} is {@code true} .

    • orderByKnowledgeCategory

      void orderByKnowledgeCategory(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the knowledge category.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsKnowledgeCategorySearchOrder

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

    • getKnowledgeCategorySearchOrder

      GradeSearchOrder getKnowledgeCategorySearchOrder()
      Gets a grade search order to order on knolwgedge category.
      Returns:
      a grade search order
      Throws:
      UnimplementedException - supportsKnowledgeCategorySearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsKnowledgeCategorySearchOrder()} is {@code true} .

    • orderByCognitiveProcess

      void orderByCognitiveProcess(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the cognitive process.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCognitiveProcessSearchOrder

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

    • getCognitiveProcessSearchOrder

      GradeSearchOrder getCognitiveProcessSearchOrder()
      Gets a grade search order to order on cognitive process.
      Returns:
      a grade search order
      Throws:
      UnimplementedException - supportsCognitiveProcessSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCognitiveProcessSearchOrder()} is {@code true} .

    • getObjectiveSearchOrderRecord

      ObjectiveSearchOrderRecord getObjectiveSearchOrderRecord(Type objectiveRecordType) throws OperationFailedException
      Gets the objective search order record corresponding to the given objective record Type .Multiple retrievals return the same underlying object.
      Parameters:
      objectiveRecordType - an objective record type
      Returns:
      the objective search order record
      Throws:
      NullArgumentException - objectiveRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(objectiveRecordType) is false
      Compliance:
      mandatory - This method must be implemented.