OSID - osid.bidding.rules.AuctionConstrainerSmartAuctionHouseSession Service Interface Definition

Interface	osid.bidding.rules.AuctionConstrainerSmartAuctionHouseSession
Implements	`osid.OsidSession`
Used By	`osid.bidding.rules.BiddingRulesManager`
Used By	`osid.bidding.rules.BiddingRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic auction houses. An `AuctionConstrainerQuery` can be retrieved from this session and mapped to this `AuctionHouse` to create a virtual collection of auction constrainers. The auction constrainer may be sequenced using the `AuctionConstrainerSearchOrder` from this session. This `AuctionHouse` has a default query that matches any auction constrainer and a default search order that specifies no sequencing. The queries may be examined using an `AuctionConstrainerQueryInspector`. The query may be modified by converting the inspector back to an `AuctionConstrainerQuery`.
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	getAuctionConstrainerQuery
Description	Gets an auction constrainer query.
Return	`osid.bidding.rules.AuctionConstrainerQuery`		the auction constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionConstrainerSearchOrder
Description	Gets an auction constrainer search order.
Return	`osid.bidding.rules.AuctionConstrainerSearchOrder`		the auction constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAuctionConstrainerQuery
Description	Applies an auction constrainer query to this auction house.
Parameters	`osid.bidding.rules.AuctionConstrainerQuery`	`auctionConstrainerQuery`	the auction constrainer query
Errors	NULL_ARGUMENT		`auctionConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auctionConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAuctionConstrainerQuery
Description	Gets an auction constrainer query inspector for this auction house.
Return	`osid.bidding.rules.AuctionConstrainerQueryInspector`		the auction constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAuctionConstrainerSequencing
Description	Applies an auction constrainer search order to this auction house.
Parameters	`osid.bidding.rules.AuctionConstrainerSearchOrder`	`auctionConstrainerSearchOrder`	the auction constrainer search order
Errors	NULL_ARGUMENT		`auctionConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auctionConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionConstrainerQueryFromInspector
Description	Gets an auction constrainer query from an inspector.
Parameters	`osid.bidding.rules.AuctionConstrainerQueryInspector`	`auctionConstrainerQueryInspector`	an auction constrainer query inspector
Return	`osid.bidding.rules.AuctionConstrainerQuery`		the auction constrainer query
Errors	NULL_ARGUMENT		`auctionConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`auctionConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.