OSID - osid.provisioning.ProvisionNotificationSession Service Interface Definition

Interface	osid.provisioning.ProvisionNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Provision` objects in this `Distributor`. This also includes existing provisions that may appear or disappear due to changes in the `Distributor` hierarchy, 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 `ProvisionLookupSession`.
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	canRegisterForProvisionNotifications
Description	Tests if this user can register for `Provision` 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 provisions 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	reliableProvisionNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeProvisionNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableProvisionNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeProvisionNotification
Description	Acknowledge a provision notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProvisions
Description	Register for notifications of new provisions. `ProvisionReceiver.newProvisions()` is invoked when a new `Provision` appears in this distributor.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProvisionsForRequest
Description	Register for notifications of new provisions for the given request `Id`. `ProvisionReceiver.newProvisions()` is invoked when a new `Provision` is created.
Parameters	`osid.id.Id`	`requestId`	the `Id` of the request to monitor
Errors	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProvisionsForBroker
Description	Register for notifications of new provisions for the given broker `Id`. `ProvisionReceiver.newProvisions()` is invoked when a new `Provision` is created.
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the broker to monitor
Errors	NULL_ARGUMENT		`brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProvisionsForProvisionable
Description	Register for notifications of new provisions for the given provisionable `Id`. `ProvisionReceiver.newProvisions()` is invoked when a new `Provision` is created.
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	registerForNewProvisionsForRecipient
Description	Register for notifications of new provisions for the given resource `Id`. `ProvisionReceiver.newProvisions()` is invoked when a new `Provision` is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the recipient 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	registerForChangedProvisions
Description	Registers for notification of updated provisions. `ProvisionReceiver.changedProvisions()` is invoked when a provision 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	registerForChangedProvisionsForRequest
Description	Register for notifications of updated provisions for the given request `Id`. `ProvisionReceiver.changedProvisions()` is invoked when a provision in this distributor is changed.
Parameters	`osid.id.Id`	`requestId`	the `Id` of the request to monitor
Errors	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProvisionsForBroker
Description	Register for notifications of updated provisions for the given broker `Id`. `ProvisionReceiver.changedProvisions()` is invoked when a provision in this distributor is changed.
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the broker to monitor
Errors	NULL_ARGUMENT		`brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProvisionsForProvisionable
Description	Register for notifications of updated provisions for the given provisionable `Id`. `ProvisionReceiver.changedProvisions()` is invoked when a provision 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	registerForChangedProvisionsForRecipient
Description	Register for notifications of updated provisions for the given recipient `Id`. `ProvisionReceiver.changedProvisions()` is invoked when a provision in this distributor is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the recipient 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	registerForChangedProvision
Description	Registers for notification of an updated provision. `ProvisionReceiver.changedProvisions()` is invoked when the specified provision in this distributor is changed.
Parameters	`osid.id.Id`	`provisionId`	the `Id` of the `Provision` to monitor
Errors	NULL_ARGUMENT		`provisionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProvisions
Description	Registers for notification of deleted provisions. `ProvisionReceiver.deletedProvisions()` is invoked when a provision 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	registerForDeletedProvisionsForRequest
Description	Register for notifications of deleted provisions for the given request `Id`. `ProvisionReceiver.deletedProvisions()` is invoked when a provision in this distributor is removed or deleted.
Parameters	`osid.id.Id`	`requestId`	the `Id` of the request to monitor
Errors	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProvisionsForBroker
Description	Register for notifications of deleted provisions for the given broker `Id`. `ProvisionReceiver.deletedProvisions()` is invoked when a provision in this distributor is removed or deleted.
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the broker to monitor
Errors	NULL_ARGUMENT		`brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProvisionsForProvisionable
Description	Register for notifications of deleted provisions for the given provisionable `Id`. `ProvisionReceiver.deletedProvisions()` is invoked when a provision in this distributor is removed or deleted.
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	registerForDeletedProvisionsForRecipient
Description	Register for notifications of deleted provisions for the given recipient `Id`. `ProvisionReceiver.deletedProvisions()` is invoked when a provision in this distributor is removed or deleted.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the recipient 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	registerForDeletedProvision
Description	Registers for notification of a deleted provision. `ProvisionReceiver.deletedProvisions()` is invoked when the specified provision is deleted or removed from this distributor.
Parameters	`osid.id.Id`	`provisionId`	the `Id` of the `Provision` to monitor
Errors	NULL_ARGUMENT		`provisionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.