Interface | osid.bidding.BidQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching bids. Each method match
specifies an | ||
Method | matchAuctionId | ||
Description |
Sets the auction | ||
Parameters | osid.id.Id | auctionId | the auction Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | auctionId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAuctionIdTerms | ||
Description |
Clears the auction | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAuctionQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an auction query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionQuery | ||
Description |
Gets the query for an auction. Multiple retrievals
produce a nested | ||
Return | osid.bidding.AuctionQuery | the auction query | |
Errors | UNIMPLEMENTED | supportsAuctionQuery() is false | |
Compliance | optional | This method must be implemented if supportsAuctionQuery() is
true. | |
Method | clearAuctionTerms | ||
Description |
Clears the auction query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchBidderId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | the resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearBidderIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBidderQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBidderQuery | ||
Description |
Gets the query for a resource. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsBidderQuery() is false | |
Compliance | optional | This method must be implemented if supportsBidderQuery() is
true. | |
Method | clearBidderTerms | ||
Description |
Clears the resource query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchBiddingAgentId | ||
Description |
Sets the agent | ||
Parameters | osid.id.Id | agentId | the agent Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearBiddingAgentIdTerms | ||
Description |
Clears the agent | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBiddingAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBiddingAgentQuery | ||
Description |
Gets the query for an agent. Multiple retrievals
produce a nested | ||
Return | osid.authentication.AgentQuery | the agent query | |
Errors | UNIMPLEMENTED | supportsBiddingAgentQuery() is false | |
Compliance | optional | This method must be implemented if supportsBiddingAgentQuery()
is true. | |
Method | clearBiddingAgentTerms | ||
Description |
Clears the agent query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchQuantity | ||
Description |
Matches bids with quantities between the given range inclusive. | ||
Parameters | cardinal | start | start range |
cardinal | end | end range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
Compliance | mandatory | This method must be implemented. | |
Method | clearQuantityTerms | ||
Description |
Clears the quantity query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCurrentBid | ||
Description |
Matches bids with a current bidsbetween the given range inclusive. | ||
Parameters | osid.financials.Currency | start | start range |
osid.financials.Currency | end | end range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end or
start.getCurencyType() != end.getCurrencyType() | |
NULL_ARGUMENT | currency is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCurrentBidTerms | ||
Description |
Clears the current bid query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMaximumBid | ||
Description |
Matches bids with a max bid between the given range inclusive. | ||
Parameters | osid.financials.Currency | start | start range |
osid.financials.Currency | end | end range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end or
start.getCurencyType() != end.getCurrencyType() | |
NULL_ARGUMENT | currency is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearMaximumBidTerms | ||
Description |
Clears the max bid query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWinner | ||
Description |
Matches winning bids. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearWinnerTerms | ||
Description |
Clears the winner query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSettlementAmount | ||
Description |
Matches bids with a settlement amount between the given range inclusive. | ||
Parameters | osid.financials.Currency | start | start range |
osid.financials.Currency | end | end range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end or
start.getCurencyType() != end.getCurrencyType() | |
NULL_ARGUMENT | currency is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSettlementAmountTerms | ||
Description |
Clears the settlement amount query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAuctionHouseId | ||
Description |
Sets the auction house | ||
Parameters | osid.id.Id | auctionHouseId | the auction house Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | auctionHouseId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAuctionHouseIdTerms | ||
Description |
Clears the auction house | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAuctionHouseQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a auction house query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionHouseQuery | ||
Description |
Gets the query for a auction house. Multiple retrievals
produce a nested | ||
Return | osid.bidding.AuctionHouseQuery | the auction house query | |
Errors | UNIMPLEMENTED | supportsAuctionHouseQuery() is false | |
Compliance | optional | This method must be implemented if supportsAuctionHouseQuery()
is true. | |
Method | clearAuctionHouseTerms | ||
Description |
Clears the auction house query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBidQueryRecord | ||
Description |
Gets the bid query record corresponding to the given
| ||
Parameters | osid.type.Type | bidRecordType | a bid record type |
Return | osid.bidding.records.BidQueryRecord | the bid query 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. |