Interface | osid.bidding.rules.AuctionConstrainerQuery | ||
---|---|---|---|
Implements | osid.OsidConstrainerQuery | ||
Description |
This is the query for searching auction constrainers. Each
method match specifies an | ||
Method | matchRuledAuctionId | ||
Description |
Matches mapped to 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 | clearRuledAuctionIdTerms | ||
Description |
Clears the auction | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledAuctionQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an auction query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledAuctionQuery | ||
Description |
Gets the query for an auction. Multiple retrievals
produce a nested | ||
Return | osid.bidding.AuctionQuery | the auction query | |
Errors | UNIMPLEMENTED | supportsRuledAuctionQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledAuctionQuery()
is true. | |
Method | matchAnyRuledAuction | ||
Description |
Matches mapped to any auction. | ||
Parameters | boolean | match | true for mapped to any auction, false to
match mapped to no auction |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledAuctionTerms | ||
Description |
Clears the auction query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAuctionHouseId | ||
Description |
Matches mapped to 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 | getAuctionConstrainerQueryRecord | ||
Description |
Gets the auction constrainer query record corresponding
to the given | ||
Parameters | osid.type.Type | auctionConstrainerRecordType | an auction constrainer record type |
Return | osid.bidding.rules.records.AuctionConstrainerQueryRecord | the auction constrainer query record | |
Errors | NULL_ARGUMENT | auctionConstrainerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(auctionConstrainerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |