| Interface | osid.bidding.rules.AuctionConstrainerEnablerQuery | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQuery | ||
| Description |
This is the query for searching auction constrainer
enablers. Each method match specifies an | ||
| Method | matchRuledAuctionConstrainerId | ||
| Description |
Matches enablers mapped to the auction constrainer. | ||
| Parameters | osid.id.Id | auctionConstrainerId | the auction constrainer Id |
boolean | match | true for a positive match, false for a
negative match | |
| Errors | NULL_ARGUMENT | auctionConstrainerId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearRuledAuctionConstrainerIdTerms | ||
| Description |
Clears the auction constrainer | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsRuledAuctionConstrainerQuery | ||
| Description |
Tests if an | ||
| Return | boolean | true if an auction constrainer query is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledAuctionConstrainerQuery | ||
| Description |
Gets the query for an auction constrainer. Multiple
retrievals produce a nested | ||
| Return | osid.bidding.rules.AuctionConstrainerQuery | the auction constrainer query | |
| Errors | UNIMPLEMENTED | supportsRuledAuctionConstrainerQuery() is false
| |
| Compliance | optional | This method must be implemented if
supportsRuledAuctionConstrainerQuery() is true. | |
| Method | matchAnyRuledAuctionConstrainer | ||
| Description |
Matches enablers mapped to any auction constrainer. | ||
| Parameters | boolean | match | true for enablers mapped to any auction constrainer,
false to match enablers mapped to no auction constrainers |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearRuledAuctionConstrainerTerms | ||
| Description |
Clears the auction constrainer query terms. | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | matchAuctionHouseId | ||
| Description |
Matches enablers 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 | getAuctionConstrainerEnablerQueryRecord | ||
| Description |
Gets the auction constrainer enabler query record
corresponding to the given | ||
| Parameters | osid.type.Type | auctionConstrainerEnablerRecordType | an auction constrainer enabler record type |
| Return | osid.bidding.rules.records.AuctionConstrainerEnablerQueryRecord | the auction constrainer enabler query record | |
| Errors | NULL_ARGUMENT | auctionConstrainerEnablerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(auctionConstrainerEnablerRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |