OSID - osid.provisioning.BrokerNotificationSession Service Interface Definition

Interface	osid.provisioning.BrokerNotificationSession
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 `Broker` objects in this `Distributor` . This also includes existing brokers 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 `BrokerLookupSession` .
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	canRegisterForBrokerNotifications
Description	Tests if this user can register for `Broker` 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 brokers 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	reliableBrokerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeBrokerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableBrokerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeBrokerNotification
Description	Acknowledge a broker 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	registerForNewBrokers
Description	Register for notifications of new brokers. `BrokerReceiver.newBrokers()` is invoked when a new `Broker` appears in this distributor.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBrokers
Description	Registers for notification of updated brokers. `BrokerReceiver.changedBrokers()` is invoked when a broker 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	registerForChangedBroker
Description	Registers for notification of an updated broker. `BrokerReceiver.changedBrokers()` is invoked when the specified broker 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	registerForDeletedBrokers
Description	Registers for notification of deleted brokers. `BrokerReceiver.deletedBrokers()` is invoked when a broker 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	registerForDeletedBroker
Description	Registers for notification of a deleted broker. `BrokerReceiver.deletedBrokers()` is invoked when the specified broker is deleted or removed from this distributor.
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.