Interface SignalSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable
public interface SignalSearchOrder extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByPath

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

    • supportsPathSearchOrder

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

    • getPathSearchOrder

      PathSearchOrder getPathSearchOrder()
      Gets a path search order.
      Returns:
      the path search order
      Throws:
      UnimplementedException - supportsPathSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPathSearchOrder()} is {@code true}.

    • getSignalSearchOrderRecord

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