| Interface | osid.bidding.rules.AuctionProcessorEnablerQuery | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQuery | ||
| Description | 
                 This is the query for searching auction processor enablers. 
                Each method match specifies an   | ||
| Method | matchRuledAuctionProcessorId | ||
| Description | 
                     Matches enablers mapped to the auction processor.  | ||
| Parameters | osid.id.Id | auctionProcessorId | the auction  Id   | 
boolean | match |  true  for a positive match,  false  for a 
negative match  | |
| Errors | NULL_ARGUMENT |  auctionProcessorId  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearRuledAuctionProcessorIdTerms | ||
| Description | 
                     Clears the auction processor   | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsRuledAuctionProcessorQuery | ||
| Description | 
                     Tests if an   | ||
| Return | boolean |  true  if an auction processor query is available,  
false  otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledAuctionProcessorQuery | ||
| Description | 
                     Gets the query for an auction processor. Multiple 
                    retrievals produce a nested   | ||
| Return | osid.bidding.rules.AuctionProcessorQuery | the auction processor query | |
| Errors | UNIMPLEMENTED |  supportsRuledAuctionProcessorQuery()  is  false   |                 |
| Compliance | optional | This method must be implemented if  
supportsRuledAuctionProcessorQuery()  is  true.   | |
| Method | matchAnyRuledAuctionProcessor | ||
| Description | 
                     Matches enablers mapped to any auction processor.  | ||
| Parameters | boolean | match |  true  for enablers mapped to any auction processor,  
false  to match enablers mapped to no auction processors  | 
| Compliance | mandatory | This method must be implemented. | |
| Method | clearRuledAuctionProcessorTerms | ||
| Description | 
                     Clears the auction processor 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 | getAuctionProcessorEnablerQueryRecord | ||
| Description | 
                     Gets the auction processor enabler query record 
                    corresponding to the given   | ||
| Parameters | osid.type.Type | auctionProcessorEnablerRecordType | an auction processor enabler record type | 
| Return | osid.bidding.rules.records.AuctionProcessorEnablerQueryRecord | the auction processor enabler query record | |
| Errors | NULL_ARGUMENT |  auctionProcessorEnablerRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(auctionProcessorEnablerRecordType)  is  
false   |                 ||
| Compliance | mandatory | This method must be implemented. | |