OSID - osid.bidding.rules.BidEnablerQuery Service Interface Definition

Interface	osid.bidding.rules.BidEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.bidding.rules.BidEnablerQuerySession`
	`osid.bidding.rules.BidEnablerSearchSession`
	`osid.bidding.rules.BidEnablerSmartAuctionHouseSession`
Description	This is the query for searching bid enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledBidId
Description	Matches mapped to the bid.
Parameters	`osid.id.Id`	`bidId`	the bid `Id`
Parameters	`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	clearRuledBidIdTerms
Description	Clears the bid `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledBidQuery
Description	Tests if a `BidQuery` is available.
Return	`boolean`		`true` if a bid query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledBidQuery
Description	Gets the query for a bid. Multiple retrievals produce a nested `OR` term.
Return	`osid.bidding.BidQuery`		the bid query
Errors	UNIMPLEMENTED		`supportsRuledBidQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledBidQuery()` is `true`.
Method	matchAnyRuledBid
Description	Matches mapped to any bid.
Parameters	`boolean`	`match`	`true` for mapped to any bid, `false` to match mapped to no bid
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledBidTerms
Description	Clears the bid query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAuctionHouseId
Description	Sets the auction house `Id` for this query to match bids assigned to auction houses.
Parameters	`osid.id.Id`	`auctionHouseId`	the auction house `Id`
Parameters	`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 `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionHouseQuery
Description	Tests if an `AuctionHouseQuery` is available.
Return	`boolean`		`true` if an auction house query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionHouseQuery
Description	Gets the query for an auction house. Multiple retrievals produce a nested `OR` term.
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	getBidEnablerQueryRecord
Description	Gets the bid enabler query record corresponding to the given `BidEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`bidEnablerRecordType`	a bid enabler record type
Return	`osid.bidding.rules.records.BidEnablerQueryRecord`		the bid enabler query record
Errors	NULL_ARGUMENT		`bidEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(bidEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.