OSID - osid.provisioning.MyProvisionNotificationSession Service Interface Definition

Interface	osid.provisioning.MyProvisionNotificationSession
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` for resources related to the authenticated agent.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.
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	registerForNewProvisions
Description	Register for notifications of new provisions for resources related to the authenticated agent. `ProvisionReceiver.newProvision()` 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	registerForNewProvisionsForPool
Description	Register for notifications of new provisions for the given pool `Id` for resources related to the authenticated agent. `ProvisionReceiver.newProvision()` is invoked when a new `Provision` is created.
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	registerForNewProvisionsForQueue
Description	Register for notifications of new provisions for the given queue `Id` for resources related to the authenticated agent. `ProvisionReceiver.newProvision()` is invoked when a new `Provision` is created.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the queue to monitor
Errors	NULL_ARGUMENT		`queueId` 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` for resources related to the authenticated agent. `ProvisionReceiver.newProvision()` 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	registerForChangedProvisions
Description	Registers for notification of updated provisions for resources related to the authenticated agent. `ProvisionReceiver.changedProvision()` 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	registerForChangedProvisionsForPool
Description	Register for notifications of updated provisions for the given pool `Id` for resources related to the authenticated agent. `ProvisionReceiver.changedProvision()` is invoked when a provision 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	registerForChangedProvisionsForQueue
Description	Register for notifications of updated provisions for the given queue `Id` for resources related to the authenticated agent. `ProvisionReceiver.changedProvision()` is invoked when a provision in this distributor is changed.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the queue to monitor
Errors	NULL_ARGUMENT		`queueId` 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` for resources related to the authenticated agent. `ProvisionReceiver.changedProvision()` 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	registerForDeletedProvisions
Description	Registers for notification of deleted provisions for resources related to the authenticated agent. `ProvisionReceiver.deletedProvision()` 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	registerForDeletedProvisionsForPool
Description	Register for notifications of deleted provisions for the given pool `Id` for resources related to the authenticated agent. `ProvisionReceiver.deletedProvision()` is invoked when a provision in this distributor is removed or deleted.
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	registerForDeletedProvisionsForQueue
Description	Register for notifications of deleted provisions for the given queue `Id` for resources related to the authenticated agent. `ProvisionReceiver.deletedProvision()` is invoked when a provision in this distributor is removed or deleted.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the queue to monitor
Errors	NULL_ARGUMENT		`queueId` 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` for resources related to the authenticated agent. `ProvisionReceiver.deletedProvision()` is invoked when a provision in this distributor is removed or deleted.
Parameters	`osid.id.Id`	`brokerId`	the `Id` of the vroker to monitor
Errors	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.