Interface PriceSearch

All Superinterfaces:
Extensible, OsidCondition, OsidSearch, Suppliable
public interface PriceSearch extends OsidSearch

The search interface for governing price searches.

  • Method Details

    • searchAmongPrices

      void searchAmongPrices(IdList priceIds)
      Execute this search among the given list of prices.
      Parameters:
      priceIds - list of prices
      Throws:
      NullArgumentException - priceIds is null
      Compliance:
      mandatory - This method must be implemented.

    • orderPriceResults

      void orderPriceResults(PriceSearchOrder priceSearchOrder)
      Specify an ordering to the search results.
      Parameters:
      priceSearchOrder - price search order
      Throws:
      NullArgumentException - priceSearchOrder is null
      UnsupportedException - priceSearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getPriceSearchRecord

      PriceSearchRecord getPriceSearchRecord(Type priceSearchRecordType) throws OperationFailedException
      Gets the price search record corresponding to the given price search record Type.This method is used to retrieve an object implementing the requested record.
      Parameters:
      priceSearchRecordType - a price search record type
      Returns:
      the price search record
      Throws:
      NullArgumentException - priceSearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(priceSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.