OSID - osid.bidding.AuctionQuery Service Interface Definition

Interface	osid.bidding.AuctionQuery
Implements	`osid.OsidGovernatorQuery`
Used By	`osid.bidding.AuctionHouseQuery`
	`osid.bidding.AuctionQuerySession`
	`osid.bidding.AuctionSearchSession`
	`osid.bidding.AuctionSmartAuctionHouseSession`
	`osid.bidding.BidQuery`
	`osid.bidding.rules.AuctionConstrainerQuery`
	`osid.bidding.rules.AuctionProcessorQuery`
Description	This is the query for searching auctions. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchCurrencyType
Description	Matches the currency type.
Parameters	`osid.type.Type`	`currencyType`	a currency type
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`currencyType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCurrencyType
Description	Matches auctions with any currency type set.
Parameters	`boolean`	`match`	`true` to match auctions with any currency type, `false` to match auctions with no currency type
Compliance	`mandatory`		This method must be implemented.
Method	clearCurrencyTypeTerms
Description	Clears the currency type terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumBidders
Description	Matches the minimum bidders between the given range inclusive.
Parameters	`cardinal`	`start`	start of range
	`cardinal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumBidders
Description	Matches auctions with any minimum bidders set.
Parameters	`boolean`	`match`	`true` to match auctions with any minimum bidders, `false` to match auctions with no minimum bidders
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumBiddersTerms
Description	Clears the minimum bidders terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSealed
Description	Matches sealed auctions.
Parameters	`boolean`	`match`	`true` to match sealed auctions, `false` to match visible bid auctions
Compliance	`mandatory`		This method must be implemented.
Method	clearSealedTerms
Description	Clears the sealed terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSellerId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSellerIdTerms
Description	Clears the resource `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSellerQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSellerQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsSellerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSellerQuery()` is `true`.
Method	matchAnySeller
Description	Matches auctions with any seller set.
Parameters	`boolean`	`match`	`true` to match auctions with any seller, `false` to match auctions with no seller
Compliance	`mandatory`		This method must be implemented.
Method	clearSellerTerms
Description	Clears the seller query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchItemId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearItemIdTerms
Description	Clears the resource `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getItemQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemQuery()` is `true`.
Method	matchAnyItem
Description	Matches auctions with any item set.
Parameters	`boolean`	`match`	`true` to match auctions with any item, `false` to match auctions with no item
Compliance	`mandatory`		This method must be implemented.
Method	clearItemTerms
Description	Clears the seller query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLotSize
Description	Matches the lot size between the given range inclusive.
Parameters	`cardinal`	`start`	start of range
	`cardinal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyLotSize
Description	Matches auctions with any lot size set.
Parameters	`boolean`	`match`	`true` to match auctions with any lot size, `false` to match auctions with no lot size set
Compliance	`mandatory`		This method must be implemented.
Method	clearLotSizeTerms
Description	Clears the lot size terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRemainingItems
Description	Matches the remaining items between the given range inclusive.
Parameters	`cardinal`	`start`	start of range
	`cardinal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	clearRemainingItemsTerms
Description	Clears the remaining items terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchItemLimit
Description	Matches the item limit between the given range inclusive.
Parameters	`cardinal`	`start`	start of range
	`cardinal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyItemLimit
Description	Matches auctions with any item limit.
Parameters	`boolean`	`match`	`true` to match auctions with any item limit, `false` to match auctions with no item limit
Compliance	`mandatory`		This method must be implemented.
Method	clearItemLimitTerms
Description	Clears the item limit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStartingPrice
Description	Matches the starting price between the given range inclusive.
Parameters	`osid.financials.Currency`	`start`	start of range
	`osid.financials.Currency`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end` or `start.getCurencyType()`!= `end.getCurrencyType()`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyStartingPrice
Description	Matches auctions with any starting price.
Parameters	`boolean`	`match`	`true` to match auctions with any starting price, `false` to match auctions with no starting price
Compliance	`mandatory`		This method must be implemented.
Method	clearStartingPriceTerms
Description	Clears the starting price terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPriceIncrement
Description	Matches the price increment between the given range inclusive.
Parameters	`osid.financials.Currency`	`start`	start of range
	`osid.financials.Currency`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end` or `start.getCurencyType()`!= `end.getCurrencyType()`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPriceIncrement
Description	Matches auctions with any price increment.
Parameters	`boolean`	`match`	`true` to match auctions with any price increment, `false` to match auctions with no price increment
Compliance	`mandatory`		This method must be implemented.
Method	clearPriceIncrementTerms
Description	Clears the price increment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchReservePrice
Description	Matches the reserve price between the given range inclusive.
Parameters	`osid.financials.Currency`	`start`	start of range
	`osid.financials.Currency`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end` or `start.getCurencyType()`!= `end.getCurrencyType()`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyReservePrice
Description	Matches auctions with any reserve price.
Parameters	`boolean`	`match`	`true` to match auctions with any reserve price, `false` to match auctions with no reserve price
Compliance	`mandatory`		This method must be implemented.
Method	clearReservePriceTerms
Description	Clears the reserve price terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBuyoutPrice
Description	Matches the buyout price between the given range inclusive.
Parameters	`osid.financials.Currency`	`start`	start of range
	`osid.financials.Currency`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end` or `start.getCurencyType()`!= `end.getCurrencyType()`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyBuyoutPrice
Description	Matches auctions with any buyout price.
Parameters	`boolean`	`match`	`true` to match auctions with any buyout price, `false` to match auctions with no buyout price
Compliance	`mandatory`		This method must be implemented.
Method	clearBuyoutPriceTerms
Description	Clears the buyout price 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	clearBidTerms
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 auctions 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	getAuctionQueryRecord
Description	Gets the auction query record corresponding to the given `Auction` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`auctionRecordType`	an auction record type
Return	`osid.bidding.records.AuctionQueryRecord`		the auction query record
Errors	NULL_ARGUMENT		`auctionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(auctionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.