Interface ControllerSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByAddress

      void orderByAddress(SearchOrderStyle style)
      Orders the results by address.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByModel

      void orderByModel(SearchOrderStyle style)
      Orders the results by model.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelSearchOrder

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

    • getModelSearchOrder

      ModelSearchOrder getModelSearchOrder()
      Gets the model search order.
      Returns:
      the model search order
      Throws:
      IllegalStateException - supportsModelSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByVersion

      void orderByVersion(SearchOrderStyle style)
      Orders the results by version.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByToggleable

      void orderByToggleable(SearchOrderStyle style)
      Orders the results by the toggles.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByVariable

      void orderByVariable(SearchOrderStyle style)
      Orders the results by the variable capabilities.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByVariablePercentage

      void orderByVariablePercentage(SearchOrderStyle style)
      Orders the results by the variable by percentage capabilities.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByVariableMinimum

      void orderByVariableMinimum(SearchOrderStyle style)
      Orders the results by variable minimum.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByVariableMaximum

      void orderByVariableMaximum(SearchOrderStyle style)
      Orders the results by variable maximum.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDiscreetStates

      void orderByDiscreetStates(SearchOrderStyle style)
      Orders the results by the variable by discreet state capabilities.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getControllerSearchOrderRecord

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