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

Interface	osid.bidding.rules.AuctionProcessorQuery
Implements	`osid.OsidProcessorQuery`
Used By	`osid.bidding.rules.AuctionProcessorEnablerQuery`
	`osid.bidding.rules.AuctionProcessorQuerySession`
	`osid.bidding.rules.AuctionProcessorSearchSession`
	`osid.bidding.rules.AuctionProcessorSmartAuctionHouseSession`
Description	This is the query for searching auction processors. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledAuctionId
Description	Matches mapped to the auction.
Parameters	`osid.id.Id`	`auctionId`	the auction `Id`
Parameters	`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 `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledAuctionQuery
Description	Tests if an `AuctionQuery` is available.
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 `OR` term.
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`
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	getAuctionProcessorQueryRecord
Description	Gets the auction processor query record corresponding to the given `AuctionProcessor` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`auctionProcessorRecordType`	an auction processor record type
Return	`osid.bidding.rules.records.AuctionProcessorQueryRecord`		the auction processor query record
Errors	NULL_ARGUMENT		`auctionProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(auctionProcessorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.