OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.CompositionNotificationSession
Implementsosid.OsidSession
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
MethodgetRepositoryId
Description

Gets the Repository Id associated with this session.

Returnosid.id.Idthe Repository Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRepository
Description

Gets the Repository associated with this session.

Returnosid.repository.Repositorythe Repository associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForCompositionNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedRepositoryView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedRepositoryView
Description

Isolates the view for composition methods in this session. An isolated view restricts notifications to this repository only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewCompositions
Description

Register for notifications of new composition. CompositionReceiver.newCompositions() is invoked when a new Composition appears in this repository.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCompositions
Description

Register for notifications of new compositions. CompositionReceiver.changedCompositions() is invoked when a Composition is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedComposition
Description

Registers for notification of an updated composition. CompositionReceiver.changedCompositions() is invoked when the specified composition is changed.

Parametersosid.id.IdcompositionIdthe Id of the Composition to monitor
ErrorsNULL_ARGUMENT compositionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCompositions
Description

Register for notifications of new compositions. CompositionReceiver.deletedCompositions() is invoked when a Composition is removed from this repository.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedComposition
Description

Registers for notification of a deleted composition. CompositionReceiver.deletedCompositions() is invoked when the specified composition is removed from this repository.

Parametersosid.id.IdcompositionIdthe Id of the Composition to monitor
ErrorsNULL_ARGUMENT compositionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.