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

Interface	osid.bidding.rules.AuctionProcessorEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `AuctionProcessorEnablers.` 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 auction processor enabler methods in this session operate, retrieve and pertain to auction processor enablers defined explicitly in the current auction house. Using an isolated view is useful for managing `AuctionProcessorEnablers` with the `AuctionProcessorEnablerAdminSession.` federated auction house view: All auction processor enabler methods in this session operate, retrieve and pertain to all auction processor enablers defined in this auction house and any other auction processor enablers implicitly available in this auction house through auction house inheritence. active auction processor enabler view: All auction processor enabler lookup methods return active auction processor enablers. any status auction processor enabler view: Auction processor enablers of any active or inactive status are returned from methods. 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 `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
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	canLookupAuctionProcessorEnablers
Description	Tests if this user can perform `AuctionProcessorEnablers` 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	useComparativeAuctionProcessorEnablerView
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	usePlenaryAuctionProcessorEnablerView
Description	A complete view of the `AuctionProcessorEnabler` 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 auction processor 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	useActiveAuctionProcessorEnablerView
Description	Only active auction processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusAuctionProcessorEnablerView
Description	All active and inactive auction processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getAuctionProcessorEnabler
Description	Gets the `AuctionProcessorEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `AuctionProcessorEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `AuctionProcessorEnabler` and retained for compatibility. In active mode, auction processor enablers are returned that are currently active. In any status mode, active and inactive auction processor enablers are returned.
Parameters	`osid.id.Id`	`auctionProcessorEnablerId`	`Id` of the `AuctionProcessorEnabler`
Return	`osid.bidding.rules.AuctionProcessorEnabler`		the auction processor enabler
Errors	NOT_FOUND		`auctionProcessorEnablerId` not found
	NULL_ARGUMENT		`auctionProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAuctionProcessorEnablersByIds
Description	Gets an `AuctionProcessorEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the auction processor 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 `AuctionProcessorEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, auction processor enablers are returned that are currently active. In any status mode, active and inactive auction processor enablers are returned.
Parameters	`osid.id.IdList`	`auctionProcessorEnablerIds`	the list of `Ids` to retrieve
Return	`osid.bidding.rules.AuctionProcessorEnablerList`		the returned `AuctionProcessorEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`auctionProcessorEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablersByGenusType
Description	Gets an `AuctionProcessorEnablerList` corresponding to the given auction processor enabler genus `Type` which does not include auction processor enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known auction processor enablers or an error results. Otherwise, the returned list may contain only those auction processor enablers that are accessible through this session. In active mode, auction processor enablers are returned that are currently active. In any status mode, active and inactive auction processor enablers are returned.
Parameters	`osid.type.Type`	`auctionProcessorEnablerGenusType`	an auction processor enabler genus type
Return	`osid.bidding.rules.AuctionProcessorEnablerList`		the returned `AuctionProcessorEnabler` list
Errors	NULL_ARGUMENT		`auctionProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablersByParentGenusType
Description	Gets an `AuctionProcessorEnablerList` corresponding to the given auction processor enabler genus `Type` and include any additional auction processor enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known auction processor enablers or an error results. Otherwise, the returned list may contain only those auction processor enablers that are accessible through this session. In active mode, auction processor enablers are returned that are currently active. In any status mode, active and inactive auction processor enablers are returned.
Parameters	`osid.type.Type`	`auctionProcessorEnablerGenusType`	an auction processor enabler genus type
Return	`osid.bidding.rules.AuctionProcessorEnablerList`		the returned `AuctionProcessorEnabler` list
Errors	NULL_ARGUMENT		`auctionProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablersByRecordType
Description	Gets an `AuctionProcessorEnablerList` containing the given auction processor enabler record `Type.` In plenary mode, the returned list contains all known auction processor enablers or an error results. Otherwise, the returned list may contain only those auction processor enablers that are accessible through this session. In active mode, auction processor enablers are returned that are currently active. In any status mode, active and inactive auction processor enablers are returned.
Parameters	`osid.type.Type`	`auctionProcessorEnablerRecordType`	an auction processor enabler record type
Return	`osid.bidding.rules.AuctionProcessorEnablerList`		the returned `AuctionProcessorEnabler` list
Errors	NULL_ARGUMENT		`auctionProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablersOnDate
Description	Gets an `AuctionProcessorEnablerList` effective within the given date range. In plenary mode, the returned list contains all known auction processor enablers or an error results. Otherwise, the returned list may contain only those auction processor enablers that are accessible through this session. In active mode, auction processor enablers are returned that are currently active. In any status mode, active and inactive auction processor enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.bidding.rules.AuctionProcessorEnablerList`		the returned `AuctionProcessorEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablersOnDateWithAgent
Description	Gets an `AuctionProcessorEnablerList` effective during the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known auction processor enablers or an error results. Otherwise, the returned list may contain only those auction processor enablers that are accessible through this session. In active mode, auction processor enablers are returned that are currently active. In any status mode, active and inactive auction processor enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent Id
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.bidding.rules.AuctionProcessorEnablerList`		the returned `AuctionProcessorEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionProcessorEnablers
Description	Gets all `AuctionProcessorEnablers.` In plenary mode, the returned list contains all known auction processor enablers or an error results. Otherwise, the returned list may contain only those auction processor enablers that are accessible through this session. In active mode, auction processor enablers are returned that are currently active. In any status mode, active and inactive auction processor enablers are returned.
Return	`osid.bidding.rules.AuctionProcessorEnablerList`		the returned `AuctionProcessorEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.