Interface ModelSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByManufacturer

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

    • supportsManufacturerSearchOrder

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

    • getManufacturerSearchOrder

      ResourceSearchOrder getManufacturerSearchOrder()
      Gets the search order for a manufacturer resource.
      Returns:
      the resource search order
      Throws:
      UnimplementedException - supportsManufacturerSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStockSearchOrder()} is {@code true} .

    • orderByArchetype

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

    • orderByNumber

      void orderByNumber(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the model number.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getModelSearchOrderRecord

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