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

Interface	osid.provisioning.rules.PoolProcessorRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `PoolProcessor` to `Pool` mappings. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated distributor view: All methods in this session operate, retrieve and pertain pool processor defined explicitly in the current distributor federated distributor view: All methods in this session operate, retrieve and pertain to all pool processor defined in this distributor and any other pool processor implicitly available in this distributor through distributor inheritence.
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	canLookupPoolProcessorRules
Description	Tests if this user can perform lookups of pool processor/pool mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativePoolProcessorRuleView
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	usePlenaryPoolProcessorRuleView
Description	A complete view of the `PoolProcessor` and `Pool` 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 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	getPoolProcessorIdsForPool
Description	Gets the `PoolProcessor Id` associated with a `Pool.`
Parameters	`osid.id.Id`	`poolId`	`Id` of the `Pool`
Return	`osid.id.IdList`		the pool processor `Ids`
Errors	NOT_FOUND		`poolId` is not found
	NULL_ARGUMENT		`poolId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorsForPool
Description	Gets the `PoolProcessor` associated with a `Pool.`
Parameters	`osid.id.Id`	`poolId`	`Id` of the `Pool`
Return	`osid.provisioning.rules.PoolProcessorList`		the pool processors
Errors	NOT_FOUND		`poolId` is not found
	NULL_ARGUMENT		`poolId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPoolIdsForPoolProcessor
Description	Gets the `Pool` `Ids` mapped to a `PoolProcessor.`
Parameters	`osid.id.Id`	`poolProcessorId`	`Id` of a `PoolProcessor`
Return	`osid.id.IdList`		list of pool `Ids`
Errors	NOT_FOUND		`poolProcessorId` is not found
	NULL_ARGUMENT		`poolProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPoolsForPoolProcessor
Description	Gets the `Pools` mapped to a `PoolProcessor.`
Parameters	`osid.id.Id`	`poolProcessorId`	`Id` of a `PoolProcessor`
Return	`osid.provisioning.PoolList`		list of pools
Errors	NOT_FOUND		`poolProcessorId` is not found
	NULL_ARGUMENT		`poolProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.