OSID - osid.provisioning.ProvisionableDistributorSession Service Interface Definition

Interface	osid.provisioning.ProvisionableDistributorSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `Provisionable` to `Distributor` provisionables. A `Provisionable` may appear in multiple `Distributor` objects. Each distributor may have its own authorizations governing who is allowed to look at it. 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
Method	canLookupProvisionableDistributorProvisionables
Description	Tests if this user can perform lookups of provisionable/distributor 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 provisionables is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeProvisionableDistributorView
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	usePlenaryProvisionableDistributorView
Description	A complete view of the `Provisionable` and `Distributor` 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	getProvisionableIdsByDistributor
Description	Gets the list of `Provisionable Ids` associated with a `Distributor.`
Parameters	`osid.id.Id`	`distributorId`	`Id` of the `Distributor`
Return	`osid.id.IdList`		list of related provisionable `Ids`
Errors	NOT_FOUND		`distributorId` is not found
	NULL_ARGUMENT		`distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesByDistributor
Description	Gets the list of `Provisionables` associated with a `Distributor.`
Parameters	`osid.id.Id`	`distributorId`	`Id` of the `Distributor`
Return	`osid.provisioning.ProvisionableList`		list of related provisionables
Errors	NOT_FOUND		`distributorId` is not found
	NULL_ARGUMENT		`distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableIdsByDistributors
Description	Gets the list of `Provisionable Ids` corresponding to a list of `Distributors.`
Parameters	`osid.id.IdList`	`distributorIds`	list of distributor `Ids`
Return	`osid.id.IdList`		list of provisionable `Ids`
Errors	NULL_ARGUMENT		`distributorIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesByDistributors
Description	Gets the list of `Provisionables` corresponding to a list of `Distributors.`
Parameters	`osid.id.IdList`	`distributorIds`	list of distributor `Ids`
Return	`osid.provisioning.ProvisionableList`		list of provisionables
Errors	NULL_ARGUMENT		`distributorIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorIdsByProvisionable
Description	Gets the `Distributor` `Ids` mapped to a `Provisionable.`
Parameters	`osid.id.Id`	`provisionableId`	`Id` of a `Provisionable`
Return	`osid.id.IdList`		list of distributors
Errors	NOT_FOUND		`provisionableId` is not found
	NULL_ARGUMENT		`provisionableId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorsByProvisionable
Description	Gets the `Distributors` mapped to a `Provisionable.`
Parameters	`osid.id.Id`	`provisionableId`	`Id` of a `Provisionable`
Return	`osid.provisioning.DistributorList`		list of distributors
Errors	NOT_FOUND		`provisionableId` is not found
	NULL_ARGUMENT		`provisionableId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.