OSID - osid.bidding.AuctionQuerySession Service Interface Definition

Interface	osid.bidding.AuctionQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Auction` objects. The search query is constructed using the `AuctionQuery.` This session defines views that offer differing behaviors for searching. federated auction house view: searches include auctions in auction houses of which this auction house is an ancestor in the auction house hierarchy isolated auction house view: searches are restricted to auctions in this auction house Auctions may have a query record indicated by their respective record types. The query record is accessed via the `AuctionQuery.`
Method	getAuctionHouseId
Description	Gets the `AuctionHouse` `Id` associated with this session.
Return	`osid.id.Id`		the `AuctionHouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionHouse
Description	Gets the `AuctionHouse` associated with this session.
Return	`osid.bidding.AuctionHouse`		the auction house
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchAuctions
Description	Tests if this user can perform `Auction` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedAuctionHouseView
Description	Federates the view for methods in this session. A federated view will include auctions in auction houses which are children of this auction house in the auction house hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAuctionHouseView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this auction house only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAuctionQuery
Description	Gets an auction query.
Return	`osid.bidding.AuctionQuery`		the auction query
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionsByQuery
Description	Gets a list of `Auctions` matching the given search.
Parameters	`osid.bidding.AuctionQuery`	`auctionQuery`	the auction query
Return	`osid.bidding.AuctionList`		the returned `AuctionList`
Errors	NULL_ARGUMENT		`auctionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auctionQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.