OSID - osid.provisioning.rules.PoolProcessorEnablerLookupSession Service Interface Definition

Interface	osid.provisioning.rules.PoolProcessorEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `PoolProcessorEnablers.` 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 distributor view: All pool processor enabler methods in this session operate, retrieve and pertain to pool processor enablers defined explicitly in the current distributor. Using an isolated view is useful for managing `PoolProcessorEnablers` with the `PoolProcessorEnablerAdminSession.` federated distributor view: All pool processor enabler methods in this session operate, retrieve and pertain to all pool processor enablers defined in this distributor and any other pool processor enablers implicitly available in this distributor through distributor inheritence. active pool processor enabler view: All pool processor enabler lookup methods return active pool processor enablers. any status pool processor enabler view: Pool 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	getDistributorId
Description	Gets the `Distributor` `Id` associated with this session.
Return	`osid.id.Id`		the `Distributor Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDistributor
Description	Gets the `Distributor` associated with this session.
Return	`osid.provisioning.Distributor`		the distributor
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupPoolProcessorEnablers
Description	Tests if this user can perform `PoolProcessorEnablers` 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	useComparativePoolProcessorEnablerView
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	usePlenaryPoolProcessorEnablerView
Description	A complete view of the `PoolProcessorEnabler` 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	useFederatedDistributorView
Description	Federates the view for methods in this session. A federated view will include pool processor enablers in distributors which are children of this distributor in the distributor hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDistributorView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActivePoolProcessorEnablerView
Description	Only active pool processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusPoolProcessorEnablerView
Description	All active and inactive pool processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getPoolProcessorEnabler
Description	Gets the `PoolProcessorEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `PoolProcessorEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `PoolProcessorEnabler` and retained for compatibility. In active mode, pool processor enablers are returned that are currently active. In any status mode, active and inactive pool processor enablers are returned.
Parameters	`osid.id.Id`	`poolProcessorEnablerId`	`Id` of the `PoolProcessorEnabler`
Return	`osid.provisioning.rules.PoolProcessorEnabler`		the pool processor enabler
Errors	NOT_FOUND		`poolProcessorEnablerId` not found
	NULL_ARGUMENT		`poolProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getPoolProcessorEnablersByIds
Description	Gets a `PoolProcessorEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the pool 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 `PoolProcessorEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, pool processor enablers are returned that are currently active. In any status mode, active and inactive pool processor enablers are returned.
Parameters	`osid.id.IdList`	`poolProcessorEnablerIds`	the list of `Ids` to retrieve
Return	`osid.provisioning.rules.PoolProcessorEnablerList`		the returned `PoolProcessorEnabler` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`poolProcessorEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorEnablersByGenusType
Description	Gets a `PoolProcessorEnablerList` corresponding to the given pool processor enabler genus `Type` which does not include pool processor enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known pool processor enablers or an error results. Otherwise, the returned list may contain only those pool processor enablers that are accessible through this session. In active mode, pool processor enablers are returned that are currently active. In any status mode, active and inactive pool processor enablers are returned.
Parameters	`osid.type.Type`	`poolProcessorEnablerGenusType`	a pool processor enabler genus type
Return	`osid.provisioning.rules.PoolProcessorEnablerList`		the returned `PoolProcessorEnabler` list
Errors	NULL_ARGUMENT		`poolProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorEnablersByParentGenusType
Description	Gets a `PoolProcessorEnablerList` corresponding to the given pool processor enabler genus `Type` and include any additional pool processor enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known pool processor enablers or an error results. Otherwise, the returned list may contain only those pool processor enablers that are accessible through this session. In active mode, pool processor enablers are returned that are currently active. In any status mode, active and inactive pool processor enablers are returned.
Parameters	`osid.type.Type`	`poolProcessorEnablerGenusType`	a pool processor enabler genus type
Return	`osid.provisioning.rules.PoolProcessorEnablerList`		the returned `PoolProcessorEnabler` list
Errors	NULL_ARGUMENT		`poolProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorEnablersByRecordType
Description	Gets a `PoolProcessorEnablerList` containing the given pool processor enabler record `Type.` In plenary mode, the returned list contains all known pool processor enablers or an error results. Otherwise, the returned list may contain only those pool processor enablers that are accessible through this session. In active mode, pool processor enablers are returned that are currently active. In any status mode, active and inactive pool processor enablers are returned.
Parameters	`osid.type.Type`	`poolProcessorEnablerRecordType`	a pool processor enabler record type
Return	`osid.provisioning.rules.PoolProcessorEnablerList`		the returned `PoolProcessorEnabler` list
Errors	NULL_ARGUMENT		`poolProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorEnablersOnDate
Description	Gets a `PoolProcessorEnablerList` effective for the entire the given date range inclusive but not confisned to the date range for any agent. In plenary mode, the returned list contains all known pool processor enablers or an error results. Otherwise, the returned list may contain only those pool processor enablers that are accessible through this session. In active mode, pool processor enablers are returned that are currently active in addition to being effective for the given date range. In any status mode, active and inactive pool processor enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.provisioning.rules.PoolProcessorEnablerList`		the returned `PoolProcessorEnabler` 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	getPoolProcessorEnablersOnDateWithAgent
Description	Gets a `PoolProcessorEnablerList` effective for the entire the given date range inclusive but not confisned to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known pool processor enablers or an error results. Otherwise, the returned list may contain only those pool processor enablers that are accessible through this session. In active mode, pool processor enablers are returned that are currently active in addition to being effective for the given date range. In any status mode, active and inactive pool 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.provisioning.rules.PoolProcessorEnablerList`		the returned `PoolProcessorEnabler` 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	getPoolProcessorEnablers
Description	Gets all `PoolProcessorEnablers.` In plenary mode, the returned list contains all known pool processor enablers or an error results. Otherwise, the returned list may contain only those pool processor enablers that are accessible through this session. In active mode, pool processor enablers are returned that are currently active. In any status mode, active and inactive pool processor enablers are returned.
Return	`osid.provisioning.rules.PoolProcessorEnablerList`		the returned `PoolProcessorEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.