OSID - osid.installation.DepotNotificationSession Service Interface Definition

Interface	osid.installation.DepotNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.installation.InstallationManager`
Used By	`osid.installation.InstallationProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Depots`. 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	canRegisterForDepotNotifications
Description	Tests if this user can register for `Depot` 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	reliableDepotNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeDepotNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableDepotNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeDepotNotification
Description	Acknowledge a depot 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	registerForNewDepots
Description	Register for notifications of new depots. `DepotReceiver.newDepots()` is invoked when a new `Depot` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDepots
Description	Registers for notification of updated depots. `DepotReceiver.changedDepots()` is invoked when a depot is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDepot
Description	Registers for notification of an updated depot. `DepotReceiver.changedDepots()` is invoked when the specified depot is changed.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the depot to monitor
Errors	NULL_ARGUMENT		`depotId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDepots
Description	Registers for notification of deleted depots. `DepotReceiver.deletedDepots()` is invoked when a depot is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDepot
Description	Registers for notification of a deleted depot. `DepotReceiver.deletedDepots()` is invoked when the specified depot is deleted.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the depot to monitor
Errors	NULL_ARGUMENT		`depotId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDepotHierarchy
Description	Registers for notification of an updated depot hierarchy structure. DepotReceiver.changedChildOfDepots() is invoked when the specified node or any of its descendants experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDepotHierarchyForAncestors
Description	Registers for notification of an updated depot hierarchy structure. DepotReceiver.changedChildOfDepots() is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the `Depot` node to monitor
Errors	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDepotHierarchyForDescendants
Description	Registers for notification of an updated depot hierarchy structure. `DepotReceiver.changedChildOfDepots()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the `Depot` node to monitor
Errors	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.