OSID - osid.installation.PackageNotificationSession Service Interface Definition

Interface	osid.installation.PackageNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive asynchronous notifications on adds/changes to `Package` objects. 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 views defined in this session correspond to the views in the `PackageLookupSession.`
Method	getDepotId
Description	Gets the `Depot` `Id` associated with this session.
Return	`osid.id.Id`		the `Depot Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDepot
Description	Gets the `Depot` associated with this session.
Return	`osid.installation.Depot`		the `Depot` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForPackageNotifications
Description	Tests if this user can register for `Package` 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	useFederatedDepotView
Description	Federates the view for methods in this session. A federated view will include notifications for packages in depots which are children of this depot in the depot hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDepotView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this depot only.
Compliance	`mandatory`		This method is must be implemented.
Method	registerForNewPackages
Description	Register for notifications of new packages. `PackageReceiver.newPackages()` is invoked when a new package is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPackages
Description	Registers for notification of updated packages. `PackageReceiver.changedPackages()` is invoked when a package is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPackage
Description	Registers for notification of an updated package. `PackageReceiver.changedPackages()` is invoked when the specified package is changed.
Parameters	`osid.id.Id`	`packageId`	the `Id` of the `Package` to monitor
Errors	NULL_ARGUMENT		`packageId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPackages
Description	Registers for notification of deleted packages. `PackageReceiver.deletedPackages()` is invoked when a package is removed from this depot.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPackage
Description	Registers for notification of a deleted package. `PackageReceiver.deletedPackages()` is invoked when the specified package is removed from this depot.
Parameters	`osid.id.Id`	`packageId`	the `Id` of the `Package` to monitor
Errors	NULL_ARGUMENT		`packageId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.