Interface InventorySearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByStock

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

    • supportsStockSearchOrder

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

    • getStockSearchOrder

      StockSearchOrder getStockSearchOrder()
      Gets the search order for a stock.
      Returns:
      the stock search order
      Throws:
      UnimplementedException - supportsStockSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStockSearchOrder()} is {@code true} .

    • orderByDate

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

    • orderByQuantity

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

    • getInventorySearchOrderRecord

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