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

Interface	osid.bidding.rules.AuctionConstrainerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.bidding.rules.AuctionConstrainerEnablerQuerySession`
	`osid.bidding.rules.AuctionConstrainerEnablerSearchSession`
	`osid.bidding.rules.AuctionConstrainerEnablerSmartAuctionHouseSession`
Description	This is the query for searching auction constrainer enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchRuledAuctionConstrainerId
Description	Matches enablers mapped to the auction constrainer.
Parameters	`osid.id.Id`	`auctionConstrainerId`	the auction constrainer `Id`
Parameters	`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 `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledAuctionConstrainerQuery
Description	Tests if an `AuctionConstrainerQuery` is available.
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 `OR` term.
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`
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	getAuctionConstrainerEnablerQueryRecord
Description	Gets the auction constrainer enabler query record corresponding to the given `AuctionConstrainerEnabler` record `Type` . Multiple record retrievals produce a nested `OR` term.
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.