OSID - osid.bidding.BidSmartAuctionHouseSession Service Interface Definition

Interface	osid.bidding.BidSmartAuctionHouseSession
Implements	`osid.OsidSession`
Used By	`osid.bidding.BiddingManager`
Used By	`osid.bidding.BiddingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `BidQuery` can be retrieved from this session and auctionHouseped to this `AuctionHouse` to create a virtual collection of `Bids`. The bids may be sequenced using the `BidSearchOrder` from this session. This `AuctionHouse` has a default query that matches any bid and a default search order that specifies no sequencing. The queries may be examined using a `BidQueryInspector`. The query may be modified by converting the inspector back to a `BidQuery`.
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	canManageSmartAuctionHouses
Description	Tests if this user can manage smart auction houses. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart auction house management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBidQuery
Description	Gets a bid query.
Return	`osid.bidding.BidQuery`		the bid query
Compliance	`mandatory`		This method must be implemented.
Method	getBidSearchOrder
Description	Gets a bid search order.
Return	`osid.bidding.BidSearchOrder`		the bid search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBidQuery
Description	Applies a bid query to this auction house.
Parameters	`osid.bidding.BidQuery`	`bidQuery`	the bid query
Errors	NULL_ARGUMENT		`bidQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`bidQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBidQuery
Description	Gets a bid query inspector for this auction house.
Return	`osid.bidding.BidQueryInspector`		the bid query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBidSequencing
Description	Applies a bid search order to this auction house.
Parameters	`osid.bidding.BidSearchOrder`	`bidSearchOrder`	the bid search order
Errors	NULL_ARGUMENT		`bidSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`bidSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBidQueryFromInspector
Description	Gets a bid query from an inspector.
Parameters	`osid.bidding.BidQueryInspector`	`bidQueryInspector`	a bid query inspector
Return	`osid.bidding.BidQuery`		the bid query
Errors	NULL_ARGUMENT		`bidQueryInspector` is `null`
Errors	UNSUPPORTED		`bidQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.