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

Interface	osid.bidding.rules.BidEnablerLookupSession
Implements	`osid.OsidSession`
Used By	`osid.bidding.rules.BiddingRulesManager`
Used By	`osid.bidding.rules.BiddingRulesProxyManager`
Description	This session provides methods for retrieving `BidEnablers` . This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated auction house view: All bid enabler methods in this session operate, retrieve and pertain to bid enablers defined explicitly in the current auction house Using an isolated view is useful for managing `BidEnablers` with the `BidEnablerAdminSession` . federated auction house view: All bid enabler methods in this session operate, retrieve and pertain to all bid enablers defined in this auction house and any other bid enablers implicitly available in this auction house through auction house inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedAuctionHouseView()` and `useIsolatedAuctionHouseView() b` ehave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupBidEnablers
Description	Tests if this user can perform `BidEnabler` lookups. 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 opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBidEnablerView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryBidEnablerView
Description	A complete view of the `BidEnabler` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is 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 lookups to this auction house only.
Compliance	`mandatory`		This method is must be implemented.
Method	getBidEnabler
Description	Gets the `BidEnabler` specified by its `Id` . In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `BidEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `BidEnabler and retain` ed for compatibility.
Parameters	`osid.id.Id`	`bidEnablerId`	`Id` of the `BidEnabler`
Return	`osid.bidding.rules.BidEnabler`		the bid enabler
Errors	NOT_FOUND		`bidEnablerId` not found
	NULL_ARGUMENT		`bidEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getBidEnablersByIds
Description	Gets a `BidEnablerList` corresponding to the given `IdList` . In plenary mode, the returned list contains all of the bid enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `BidEnablers may be omit` ted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`bidEnablerIds`	the list of `Ids` to retrieve
Return	`osid.bidding.rules.BidEnablerList`		the returned `BidEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`bidEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablersByGenusType
Description	Gets a `BidEnablerList` corresponding to the given bid enabler genus `Type` which does not include bid enablers of genus types derived from the specified `Type` . In plenary mode, the returned list contains all known bid enablers or an error results. Otherwise, the returned list may contain only those bid enablers that are accessible through this session.
Parameters	`osid.type.Type`	`bidEnablerGenusType`	a bid enabler genus type
Return	`osid.bidding.rules.BidEnablerList`		the returned `BidEnabler` list
Errors	NULL_ARGUMENT		`bidEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablersByParentGenusType
Description	Gets a `BidEnablerList` corresponding to the given bid enabler genus `Type` and include any additional bid enablers with genus types derived from the specified `Type` . In plenary mode, the returned list contains all known bid enablers or an error results. Otherwise, the returned list may contain only those bid enablers that are accessible through this session.
Parameters	`osid.type.Type`	`bidEnablerGenusType`	a bid genus type
Return	`osid.bidding.rules.BidEnablerList`		the returned `BidEnabler` list
Errors	NULL_ARGUMENT		`bidEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablersByRecordType
Description	Gets a `BidEnablerList` containing the given bid enabler record `Type` . In plenary mode, the returned list contains all known bid enablers or an error results. Otherwise, the returned list may contain only those bid enablers that are accessible through this session.
Parameters	`osid.type.Type`	`bidEnablerRecordType`	a bid enabler record type
Return	`osid.bidding.rules.BidEnablerList`		the returned `BidEnabler` list
Errors	NULL_ARGUMENT		`bidEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBidEnablers
Description	Gets all `BidEnablers` . In plenary mode, the returned list contains all known bid enablers or an error results. Otherwise, the returned list may contain only those bid enablers that are accessible through this session.
Return	`osid.bidding.rules.BidEnablerList`		a list of `BidEnablers`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.