OSID - osid.bidding.AuctionHouseQuery Service Interface Definition

Interface	osid.bidding.AuctionHouseQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.bidding.AuctionHouseQuery`
	`osid.bidding.AuctionHouseQuerySession`
	`osid.bidding.AuctionHouseSearchSession`
	`osid.bidding.AuctionQuery`
	`osid.bidding.BidQuery`
	`osid.bidding.rules.AuctionConstrainerEnablerQuery`
	`osid.bidding.rules.AuctionConstrainerQuery`
	`osid.bidding.rules.AuctionProcessorEnablerQuery`
	`osid.bidding.rules.AuctionProcessorQuery`
	`osid.bidding.rules.BidEnablerQuery`
Description	This is the query for searching auction houses. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchAuctionId
Description	Sets the auction `Id` for this query.
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	clearAuctionIdTerms
Description	Clears the auction `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuctionQuery
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	getAuctionQuery
Description	Gets the query for an auction. Multiple retrievals produce a nested `OR` term.
Return	`osid.bidding.AuctionQuery`		the auction query
Errors	UNIMPLEMENTED		`supportsAuctionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuctionQuery()` is `true`.
Method	matchAnyAuction
Description	Matches auction houses with any auction.
Parameters	`boolean`	`match`	`true` to match auction houses with any auction, `false` to match auction houses with no auction
Compliance	`mandatory`		This method must be implemented.
Method	clearAuctionTerms
Description	Clears the auction query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBidId
Description	Sets the bid `Id` for this query.
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	clearBidIdTerms
Description	Clears the bid `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBidQuery
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	getBidQuery
Description	Gets the query for a bid. Multiple retrievals produce a nested `OR` term.
Return	`osid.bidding.BidQuery`		the bid query
Errors	UNIMPLEMENTED		`supportsBidQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBidQuery()` is `true`.
Method	matchAnyBid
Description	Matches auction houses that have any bid.
Parameters	`boolean`	`match`	`true` to match auction houses with any bid, `false` to match auction houses with no bid
Compliance	`mandatory`		This method must be implemented.
Method	clearBidTerms
Description	Clears the bid query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorAuctionHouseId
Description	Sets the auction house `Id` for this query to match auction houses that have the specified auction house as an ancestor.
Parameters	`osid.id.Id`	`auctionHouseId`	an 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	clearAncestorAuctionHouseIdTerms
Description	Clears the ancestor auction house `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorAuctionHouseQuery
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	getAncestorAuctionHouseQuery
Description	Gets the query for an `AuctionHouse`. Multiple retrievals produce a nested `OR` term.
Return	`osid.bidding.AuctionHouseQuery`		the auction house query
Errors	UNIMPLEMENTED		`supportsAncestorAuctionHouseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorAuctionHouseQuery()` is `true`.
Method	matchAnyAncestorAuctionHouse
Description	Matches auction houses with any ancestor.
Parameters	`boolean`	`match`	`true` to match auction houses with any ancestor, `false` to match root auction houses
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorAuctionHouseTerms
Description	Clears the ancestor auction house query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantAuctionHouseId
Description	Sets the auction house `Id` for this query to match auction houses that have the specified auction house as a descendant.
Parameters	`osid.id.Id`	`auctionHouseId`	an 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	clearDescendantAuctionHouseIdTerms
Description	Clears the descendant auction house `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantAuctionHouseQuery
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	getDescendantAuctionHouseQuery
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		`supportsDescendantAuctionHouseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantAuctionHouseQuery()` is `true`.
Method	matchAnyDescendantAuctionHouse
Description	Matches auction houses with any descendant.
Parameters	`boolean`	`match`	`true` to match auction houses with any descendant, `false` to match leaf auction houses
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantAuctionHouseTerms
Description	Clears the descendant auction house query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionHouseQueryRecord
Description	Gets the auction house query record corresponding to the given `AuctionHouse` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`auctionHouseRecordType`	an auction house record type
Return	`osid.bidding.records.AuctionHouseQueryRecord`		the auction house query record
Errors	NULL_ARGUMENT		`auctionHouseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(auctionHouseRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.