Interface CandidateSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByRace

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

    • supportsRaceSearchOrder

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

    • getRaceSearchOrder

      RaceSearchOrder getRaceSearchOrder()
      Gets the search order for a race.
      Returns:
      the race search order
      Throws:
      UnimplementedException - supportsRaceSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRaceSearchOrder()} is {@code true} .

    • orderByResource

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

    • supportsResourceSearchOrder

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

    • getResourceSearchOrder

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

    • getCandidateSearchOrderRecord

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