OSID - osid.repository.CompositionNotificationSession Service Interface Definition

Interface	osid.repository.CompositionNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.repository.RepositoryManager`
Used By	`osid.repository.RepositoryProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Composition` objects in this `Repository`. 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. Two view are defined in this session: `federateRepositoryView`: includes notifications of compositions in repositories of which this repository is an ancestor in the repository hierarchy `isolateRepositoryView`: restricts notifications to this `Repository` only
Method	getRepositoryId
Description	Gets the `Repository` `Id` associated with this session.
Return	`osid.id.Id`		the `Repository Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRepository
Description	Gets the `Repository` associated with this session.
Return	`osid.repository.Repository`		the `Repository` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForCompositionNotifications
Description	Tests if this user can register for `Composition` 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	useFederatedRepositoryView
Description	Federates the view for composition methods in this session. A federated view will include compositions in repositories which are children of this repository in the repository hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedRepositoryView
Description	Isolates the view for composition methods in this session. An isolated view restricts notifications to this repository only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableCompositionNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCompositionNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCompositionNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCompositionNotification
Description	Acknowledge a composition 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	registerForNewCompositions
Description	Register for notifications of new composition. `CompositionReceiver.newCompositions()` is invoked when a new `Composition` appears in this repository.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCompositions
Description	Register for notifications of new compositions. `CompositionReceiver.changedCompositions()` is invoked when a `Composition` is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedComposition
Description	Registers for notification of an updated composition. `CompositionReceiver.changedCompositions()` is invoked when the specified composition is changed.
Parameters	`osid.id.Id`	`compositionId`	the `Id` of the `Composition` to monitor
Errors	NULL_ARGUMENT		`compositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCompositions
Description	Register for notifications of new compositions. `CompositionReceiver.deletedCompositions()` is invoked when a `Composition` is removed from this repository.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedComposition
Description	Registers for notification of a deleted composition. `CompositionReceiver.deletedCompositions()` is invoked when the specified composition is removed from this repository.
Parameters	`osid.id.Id`	`compositionId`	the `Id` of the `Composition` to monitor
Errors	NULL_ARGUMENT		`compositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.