Interface SettingSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByController

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

    • supportsControllerSearchOrder

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

    • getControllerSearchOrder

      ControllerSearchOrder getControllerSearchOrder()
      Gets the controller search order.
      Returns:
      the controller search order
      Throws:
      IllegalStateException - supportsControllerSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByOn

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

    • orderByOff

      void orderByOff(SearchOrderStyle style)
      Orders the results by off status,
      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 variable percentage.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByVariableAmount

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

    • orderByDiscreetState

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

    • supportsDiscreetStateSearchOrder

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

    • getDiscreetStateSearchOrder

      StateSearchOrder getDiscreetStateSearchOrder()
      Gets the state search order.
      Returns:
      the state search order
      Throws:
      IllegalStateException - supportsDiscreetStateSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByRampRate

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

    • getSettingSearchOrderRecord

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