OSID Logo
OSID Specifications
repository rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.rules.CompositionEnablerNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to CompositionEnabler objects in this Composition. This also includes existing CompositionEnablers that may appear or disappear due to changes in the Composition 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 CompositionEnablerLookupSession.

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForCompositionEnablerNotifications
Description

Tests if this user can register for CompositionEnabler 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 methods in this session. A federated view will include composition enablers in repositories which are children of this repository in the repository hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedRepositoryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableCompositionEnablerNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeCompositionEnablerNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableCompositionEnablerNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCompositionEnablerNotification
Description

Acknowledge a composition enabler notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCompositionEnablers
Description

Register for notifications of new composition enablers. CompositionEnablerReceiver.newCompositionEnablers() is invoked when a new CompositionEnabler appears in this repository.

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

Registers for notification of updated composition enabelrs. CompositionEnablerReceiver.changedCompositionEnablers() is invoked when a composition enabler in this repository is changed.

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

Registers for notification of an updated composition enabler. ProvisionableReceiver.changedCompositionEnablers() is invoked when the specified composition enabler in this repository is changed.

Parametersosid.id.IdcompositionEnablerIdthe Id of the CompositionEnabler to monitor
ErrorsNULL_ARGUMENT compositionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCompositionEnablers
Description

Registers for notification of deleted composition enablers. CompositionEnablerReceiver.deletedCompositionEnablers() is invoked when a composition enabler is deleted or removed from this repository.

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

Registers for notification of a deleted composition enabler. CompositionEnablerReceiver.deletedCompositionEnablers() is invoked when the specified composition enabler is deleted or removed from this repository.

Parametersosid.id.IdcompositionEnablerIdthe Id of the CompositionEnabler to monitor
ErrorsNULL_ARGUMENT compositionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.