OSID - osid.bidding.AuctionSmartAuctionHouseSession Service Interface Definition

Interface	osid.bidding.AuctionSmartAuctionHouseSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `AuctionQuery` can be retrieved from this session and auctionHouseped to this `AuctionHouse` to create a virtual collection of `Auctions.` The auctions may be sequenced using the `AuctionSearchOrder` from this session. This `AuctionHouse` has a default query that matches any auction and a default search order that specifies no sequencing. The queries may be examined using an `AuctionQueryInspector.` The query may be modified by converting the inspector back to an `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	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	getAuctionQuery
Description	Gets an auction query.
Return	`osid.bidding.AuctionQuery`		the auction query
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionSearchOrder
Description	Gets an auction search order.
Return	`osid.bidding.AuctionSearchOrder`		the auction search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAuctionQuery
Description	Applies an auction query to this auction house.
Parameters	`osid.bidding.AuctionQuery`	`auctionQuery`	the auction query
Errors	NULL_ARGUMENT		`auctionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auctionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAuctionQuery
Description	Gets an auction query inspector for this auction house.
Return	`osid.bidding.AuctionQueryInspector`		the auction query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAuctionSequencing
Description	Applies an auction search order to this auction house.
Parameters	`osid.bidding.AuctionSearchOrder`	`auctionSearchOrder`	the auction search order
Errors	NULL_ARGUMENT		`auctionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auctionSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionQueryFromInspector
Description	Gets an auction query from an inspector.
Parameters	`osid.bidding.AuctionQueryInspector`	`auctionQueryInspector`	an auction query inspector
Return	`osid.bidding.AuctionQuery`		the auction query
Errors	NULL_ARGUMENT		`auctionQueryInspector` is `null`
Errors	UNSUPPORTED		`auctionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.