Interface ValueSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, Suppliable
public interface ValueSearchOrder extends OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSubjugateableSearchOrder

This interface specifies options for ordering search results.

  • Method Details

    • orderByPriority

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

    • orderByValue

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

    • supportsParameterSearchOrder

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

    • getParameterSearchOrder

      ParameterSearchOrder getParameterSearchOrder()
      Gets the parameter search order.
      Returns:
      the parameter search order
      Throws:
      UnimplementedException - supportsParameterSearchOrder() is false
      Compliance:
      optional - This method must be implemented is {@code supportsParameterSearchOrder()} is {@code true} .

    • getValueSearchOrderRecord

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