Interface AuctionSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable
public interface AuctionSearchOrder extends OsidGovernatorSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByCurrencyType

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

    • orderByMinimumBidders

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

    • orderBySealed

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

    • orderBySeller

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

    • supportsSellerSearchOrder

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

    • getSellerSearchOrder

      ResourceSearchOrder getSellerSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsSellerSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByItem

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

    • supportsItemSearchOrder

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

    • getItemSearchOrder

      ResourceSearchOrder getItemSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsItemSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByLotSize

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

    • orderByRemainingItems

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

    • orderByItemLimit

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

    • orderByStartingPrice

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

    • orderByPriceIncrement

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

    • orderByReservePrice

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

    • orderByBuyoutPrice

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

    • getAuctionSearchOrderRecord

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