Interface BidSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface BidSearchOrder extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByAuction

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

    • supportsAuctionSearchOrder

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

    • getAuctionSearchOrder

      AuctionSearchOrder getAuctionSearchOrder()
      Gets the auction search order.
      Returns:
      the auction search order
      Throws:
      IllegalStateException - supportsAuctionSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByBidder

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

    • supportsBidderSearchOrder

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

    • getBidderSearchOrder

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

    • orderByBiddingAgent

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

    • supportsBiddingAgentSearchOrder

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

    • getBiddingAgentSearchOrder

      AgentSearchOrder getBiddingAgentSearchOrder()
      Gets the bidding agent search order.
      Returns:
      the agent search order
      Throws:
      IllegalStateException - supportsBiddingAgentSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByQuantity

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

    • orderByCurrentBid

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

    • orderByMaximumBid

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

    • orderByWinner

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

    • orderBySettlementAmount

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

    • getBidSearchOrderRecord

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