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

Interface	osid.bidding.rules.BidEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.bidding.rules.BidEnablerSearchSession`
Used By	`osid.bidding.rules.BiddingRulesManager`
Used By	`osid.bidding.rules.BiddingRulesProxyManager`
Description	This session provides methods for searching among `BidEnabler` objects. The search query is constructed using the `BidEnablerQuery` . This session defines views that offer differing behaviors for searching. federated auction house view: searches include bid enablers in auction houses of which this auction house is an ancestor in the auction house hierarchy isolated auction house view: searches are restricted to bid enablers in this auction house Bid enablers may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchBidEnablers
Description	Tests if this user can perform `BidEnabler` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedAuctionHouseView
Description	Federates the view for methods in this session. A federated view will include bid enablers in auction houses which are children of this auction house in the auction house hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAuctionHouseView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this auction house only.
Compliance	`mandatory`		This method is 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	getBidEnablersByQuery
Description	Gets a list of `BidEnablers` matching the given search.
Parameters	`osid.bidding.rules.BidEnablerQuery`	`bidEnablerQuery`	the bid enabler query
Return	`osid.bidding.rules.BidEnablerList`		the returned `BidEnablerList`
Errors	NULL_ARGUMENT		`bidEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`bidEnablerQuery` did not originate from `getBidEnablerQuery()`
Compliance	`mandatory`		This method must be implemented.