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

Interface	osid.bidding.rules.AuctionProcessorEnablerSmartAuctionHouseSession
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 `AuctionProcessorEnablerQuery` can be retrieved from this session and mapped to this `AuctionHouse` to create a virtual collection of auction processor enablers. The auction processor enablers may be sequenced using the `AuctionProcessorEnablerSearchOrder` from this session. This `AuctionHouse` has a default query that matches any auction processor enabler and a default search order that specifies no sequencing. The queries may be examined using an `AuctionProcessorEnablerQueryInspector`. The query may be modified by converting the inspector back to an `AuctionProcessorEnablerQuery`.
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	getAuctionProcessorEnablerQuery
Description	Gets an auction processor enabler query.
Return	`osid.bidding.rules.AuctionProcessorEnablerQuery`		the auction processor enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablerSearchOrder
Description	Gets an auction processor enabler search order.
Return	`osid.bidding.rules.AuctionProcessorEnablerSearchOrder`		the auction processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyAuctionProcessorEnablerQuery
Description	Applies an auction processor enabler query to this auction house.
Parameters	`osid.bidding.rules.AuctionProcessorEnablerQuery`	`auctionProcessorEnablerQuery`	the auction processor enabler query
Errors	NULL_ARGUMENT		`auctionProcessorEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auctionProcessorEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectAuctionProcessorEnablerQuery
Description	Gets an auction processor enabler query inspector for this auction house.
Return	`osid.bidding.rules.AuctionProcessorEnablerQueryInspector`		the auction processor enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyAuctionProcessorEnablerSequencing
Description	Applies an auction processor enabler search order to this auction house.
Parameters	`osid.bidding.rules.AuctionProcessorEnablerSearchOrder`	`auctionProcessorEnablerSearchOrder`	the auction processor enabler search order
Errors	NULL_ARGUMENT		`auctionProcessorEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`auctionProcessorEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablerQueryFromInspector
Description	Gets an auction processor enabler query from an inspector.
Parameters	`osid.bidding.rules.AuctionProcessorEnablerQueryInspector`	`auctionProcessorEnablerQueryInspector`	an auction processor enabler query inspector
Return	`osid.bidding.rules.AuctionProcessorEnablerQuery`		the auction processor enabler query
Errors	NULL_ARGUMENT		`auctionProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`auctionProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.