Interface | osid.bidding.AuctionHouseQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching auction houses. 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 | matchAnyAuction | ||
Description |
Matches auction houses with any auction. | ||
Parameters | boolean | match | true to match auction houses with any auction, false
to match auction houses with no auction |
Compliance | mandatory | This method must be implemented. | |
Method | clearAuctionTerms | ||
Description |
Clears the auction query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchBidId | ||
Description |
Sets the bid | ||
Parameters | osid.id.Id | bidId | the bid Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | bidId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearBidIdTerms | ||
Description |
Clears the bid | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBidQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a bid query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBidQuery | ||
Description |
Gets the query for a bid. Multiple retrievals produce a
nested | ||
Return | osid.bidding.BidQuery | the bid query | |
Errors | UNIMPLEMENTED | supportsBidQuery() is false | |
Compliance | optional | This method must be implemented if supportsBidQuery() is
true. | |
Method | matchAnyBid | ||
Description |
Matches auction houses that have any bid. | ||
Parameters | boolean | match | true to match auction houses with any bid, false
to match auction houses with no bid |
Compliance | mandatory | This method must be implemented. | |
Method | clearBidTerms | ||
Description |
Clears the bid query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorAuctionHouseId | ||
Description |
Sets the auction house | ||
Parameters | osid.id.Id | auctionHouseId | an 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 | clearAncestorAuctionHouseIdTerms | ||
Description |
Clears the ancestor auction house | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorAuctionHouseQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an auction house query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorAuctionHouseQuery | ||
Description |
Gets the query for an | ||
Return | osid.bidding.AuctionHouseQuery | the auction house query | |
Errors | UNIMPLEMENTED | supportsAncestorAuctionHouseQuery() is false | |
Compliance | optional | This method must be implemented if
supportsAncestorAuctionHouseQuery() is true. | |
Method | matchAnyAncestorAuctionHouse | ||
Description |
Matches auction houses with any ancestor. | ||
Parameters | boolean | match | true to match auction houses with any ancestor, false
to match root auction houses |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorAuctionHouseTerms | ||
Description |
Clears the ancestor auction house query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantAuctionHouseId | ||
Description |
Sets the auction house | ||
Parameters | osid.id.Id | auctionHouseId | an 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 | clearDescendantAuctionHouseIdTerms | ||
Description |
Clears the descendant auction house | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantAuctionHouseQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an auction house query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantAuctionHouseQuery | ||
Description |
Gets the query for an auction house. Multiple
retrievals produce a nested | ||
Return | osid.bidding.AuctionHouseQuery | the auction house query | |
Errors | UNIMPLEMENTED | supportsDescendantAuctionHouseQuery() is false
| |
Compliance | optional | This method must be implemented if
supportsDescendantAuctionHouseQuery() is true. | |
Method | matchAnyDescendantAuctionHouse | ||
Description |
Matches auction houses with any descendant. | ||
Parameters | boolean | match | true to match auction houses with any descendant,
false to match leaf auction houses |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantAuctionHouseTerms | ||
Description |
Clears the descendant auction house query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuctionHouseQueryRecord | ||
Description |
Gets the auction house query record corresponding to
the given | ||
Parameters | osid.type.Type | auctionHouseRecordType | an auction house record type |
Return | osid.bidding.records.AuctionHouseQueryRecord | the auction house query record | |
Errors | NULL_ARGUMENT | auctionHouseRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(auctionHouseRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |