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

Interface	osid.bidding.rules.AuctionProcessorSmartAuctionHouseSession
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 `AuctionProcessorQuery` can be retrieved from this session and mapped to this `AuctionHouse` to create a virtual collection of auction processors. The auction processor may be sequenced using the `AuctionProcessorSearchOrder` from this session. This `AuctionHouse` has a default query that matches any auction processor and a default search order that specifies no sequencing. The queries may be examined using an `AuctionProcessorQueryInspector` . The query may be modified by converting the inspector back to an `AuctionProcessorQuery` .
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	getAuctionProcessorQuery
Description	Gets an auction processor query.
Return	`osid.bidding.rules.AuctionProcessorQuery`		the auction processor query
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorSearchOrder
Description	Gets an auction processor search order.
Return	`osid.bidding.rules.AuctionProcessorSearchOrder`		the auction processor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAuctionProcessorQuery
Description	Applies an auction processor query to this auction house.
Parameters	`osid.bidding.rules.AuctionProcessorQuery`	`auctionProcessorQuery`	the auction processor query
Errors	NULL_ARGUMENT		`auctionProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auctionProcessorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAuctionProcessorQuery
Description	Gets an auction processor query inspector for this auction house.
Return	`osid.bidding.rules.AuctionProcessorQueryInspector`		the auction processor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAuctionProcessorSequencing
Description	Applies an auction processor search order to this auction house.
Parameters	`osid.bidding.rules.AuctionProcessorSearchOrder`	`auctionProcessorSearchOrder`	the auction processor search order
Errors	NULL_ARGUMENT		`auctionProcessorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auctionProcessorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorQueryFromInspector
Description	Gets an auction processor query from an inspector.
Parameters	`osid.bidding.rules.AuctionProcessorQueryInspector`	`auctionProcessorQueryInspector`	an auction processor query inspector
Return	`osid.bidding.rules.AuctionProcessorQuery`		the auction processor query
Errors	NULL_ARGUMENT		`auctionProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`auctionProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.