Interface ProficiencySearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByResource

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

    • supportsResourceSearchOrder

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

    • getResourceSearchOrder

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

    • orderByObjective

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

    • supportsObjectiveSearchOrder

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

    • getObjectiveSearchOrder

      ObjectiveSearchOrder getObjectiveSearchOrder()
      Gets an objective search order.
      Returns:
      an objective search order
      Throws:
      UnimplementedException - supportsObjectiveSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsObjectiveSearchOrder()} is {@code true} .

    • orderByCompletion

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

    • orderByLevel

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

    • supportsLevelSearchOrder

      boolean supportsLevelSearchOrder()
      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.

    • getLevelSearchOrder

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

    • getProficiencySearchOrderRecord

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