OSID - osid.provisioning.ProvisionableNotificationSession Service Interface Definition

Interface	osid.provisioning.ProvisionableNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Provisionable` objects in this `dDstributor.` This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. The two views defined in this session correspond to the views in the `ProvisionableLookupSession.`
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	canRegisterForProvisionableNotifications
Description	Tests if this user can register for `Provisionable` notifications. 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 notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedDistributorView
Description	Federates the view for methods in this session. A federated view will include provisionables 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 notifications to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	registerForNewProvisionables
Description	Register for notifications of new provisionables. `ProvisionableReceiver.newProvisionables()` is invoked when a new `Provisionable` appears in this distributor.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProvisionablesForResource
Description	Register for notifications of new provisionables for the given resource. `ProvisionableReceiver.newProvisionables()` is invoked when a new `Provisionable` appears in this distributor.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProvisionablesForPool
Description	Register for notifications of new provisionables for the given pool. `ProvisionableReceiver.newProvisionables()` is invoked when a new `Provisionable` appears in this distributor.
Parameters	`osid.id.Id`	`poolId`	the `Id` of the pool to monitor
Errors	NULL_ARGUMENT		`poolId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProvisionables
Description	Registers for notification of updated provisionables. `ProvisionableReceiver.changedProvisionables()` is invoked when a provisionable in this distributor is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProvisionablesForResource
Description	Registers for notification of updated provisionables for the given resource. `ProvisionableReceiver.changedProvisionables()` is invoked when a provisionable in this distributor is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProvisionablesForPool
Description	Registers for notification of updated provisionables for the given pool. `ProvisionableReceiver.changedProvisionables()` is invoked when a provisionable in this distributor is changed.
Parameters	`osid.id.Id`	`poolId`	the `Id` of the pool to monitor
Errors	NULL_ARGUMENT		`poolId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProvisionable
Description	Registers for notification of an updated provisionable. `ProvisionableReceiver.changedProvisionables()` is invoked when the specified provisionable in this distributor is changed.
Parameters	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable` to monitor
Errors	NULL_ARGUMENT		`provisionableId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProvisionables
Description	Registers for notification of deleted provisionables. `ProvisionableReceiver.deletedProvisionables()` is invoked when a provisionable is deleted or removed from this distributor.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProvisionablesForResource
Description	Registers for notification of deleted provisionables for the given resource. `ProvisionableReceiver.deletedProvisionables()` is invoked when a provisionable is deleted or removed from this distributor.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProvisionablesForPool
Description	Registers for notification of deleted provisionables for the given pool. `ProvisionableReceiver.deletedProvisionables()` is invoked when a provisionable is deleted or removed from this distributor.
Parameters	`osid.id.Id`	`poolId`	the `Id` of the pool to monitor
Errors	NULL_ARGUMENT		`poolId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProvisionable
Description	Registers for notification of a deleted provisionable. `ProvisionableReceiver.deletedProvisionables()` is invoked when the specified provisionable is deleted or removed from this distributor.
Parameters	`osid.id.Id`	`provisionableId`	the `Id` of the `Provisionable` to monitor
Errors	NULL_ARGUMENT		`provisionableId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.