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

Interface	osid.bidding.rules.BidEnablerSmartAuctionHouseSession
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 catalogs. A `BidEnablerQuery` can be retrieved from this session and mapped to this `AuctionHouse` to create a virtual collection of `BidEnablers` . The bid enablers may be sequenced using the `BidEnablerSearchOrder` from this session. This `AuctionHouse` has a default query that matches any bid enabler and a default search order that specifies no sequencing. The queries may be examined using a `BidEnablerQueryInspector. Th` e query may be modified by converting the inspector back to a `BidEnablerQuery` .
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	getBidEnablerQuery
Description	Gets a bid enabler query.
Return	`osid.bidding.rules.BidEnablerQuery`		the bid enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablerSearchOrder
Description	Gets a bid enabler search order.
Return	`osid.bidding.rules.BidEnablerSearchOrder`		the bid enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBidEnablerQuery
Description	Applies a bid enabler query to this auction house.
Parameters	`osid.bidding.rules.BidEnablerQuery`	`bidEnablerQuery`	the bid enabler query
Errors	NULL_ARGUMENT		`bidEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`bidEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBidEnablerQuery
Description	Gets a bid enabler query inspector for this auction house.
Return	`osid.bidding.rules.BidEnablerQueryInspector`		the bid enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBidEnablerSequencing
Description	Applies a bid enabler search order to this auction house.
Parameters	`osid.bidding.rules.BidEnablerSearchOrder`	`bidEnablerSearchOrder`	the bid enabler search order
Errors	NULL_ARGUMENT		`bidEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`bidEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablerQueryFromInspector
Description	Gets a bid enabler query from an inspector.
Parameters	`osid.bidding.rules.BidEnablerQueryInspector`	`bidEnablerQueryInspector`	a bid enabler query inspector
Return	`osid.bidding.BidQuery`		the bid enabler query
Errors	NULL_ARGUMENT		`bidEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`bidEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.