OSID Specifications
bidding package
Version 3.0.0
bidding package
Version 3.0.0
| Interface | osid.bidding.BidSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Used By | osid.bidding.BidSearchSession | ||
osid.bidding.BidSmartAuctionHouseSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByAuction | ||
| Description |
Orders the results by auction. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAuctionSearchOrder | ||
| Description |
Tests if an auction search order is available. | ||
| Return | boolean | true if an auction search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuctionSearchOrder | ||
| Description |
Gets the auction search order. | ||
| Return | osid.bidding.AuctionSearchOrder | the auction search order | |
| Errors | ILLEGAL_STATE | supportsAuctionSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBidder | ||
| Description |
Orders the results by bidder. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsBidderSearchOrder | ||
| Description |
Tests if a bidder search order is available. | ||
| Return | boolean | true if a bidder search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBidderSearchOrder | ||
| Description |
Gets the bidder search order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | ILLEGAL_STATE | supportsBidderSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBiddingAgent | ||
| Description |
Orders the results by bidding agent. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsBiddingAgentSearchOrder | ||
| Description |
Tests if a bidding agent search order is available. | ||
| Return | boolean | true if a bidding agent search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBiddingAgentSearchOrder | ||
| Description |
Gets the bidding agent search order. | ||
| Return | osid.authentication.AgentSearchOrder | the agent search order | |
| Errors | ILLEGAL_STATE | supportsBiddingAgentSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByQuantity | ||
| Description |
Orders the results by the quantity. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCurrentBid | ||
| Description |
Orders the results by the current bid. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMaximumBid | ||
| Description |
Orders the results by the maximum bid. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByWinner | ||
| Description |
Orders the results by winning bids. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySettlementAmount | ||
| Description |
Orders the results by the settlement amount. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBidSearchOrderRecord | ||
| Description |
Gets the bid order record corresponding to the given
bid record | ||
| Parameters | osid.type.Type | bidRecordType | a bid record type |
| Return | osid.bidding.records.BidSearchOrderRecord | the bid search order record | |
| Errors | NULL_ARGUMENT | bidRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(bidRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |