public interface CompositionEnablerNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCompositionEnablerNotification(Id notificationId)
Acknowledge a composition enabler notification.
|
boolean |
canRegisterForCompositionEnablerNotifications()
Tests if this user can register for
CompositionEnabler
notifications. |
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
void |
registerForChangedCompositionEnabler(Id compositionEnablerId)
Registers for notification of an updated composition enabler.
|
void |
registerForChangedCompositionEnablers()
Registers for notification of updated composition enabelrs.
|
void |
registerForDeletedCompositionEnabler(Id compositionEnablerId)
Registers for notification of a deleted composition enabler.
|
void |
registerForDeletedCompositionEnablers()
Registers for notification of deleted composition enablers.
|
void |
registerForNewCompositionEnablers()
Register for notifications of new composition enablers.
|
void |
reliableCompositionEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableCompositionEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedRepositoryView()
Federates the view for methods in this session.
|
void |
useIsolatedRepositoryView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getRepositoryId()
Repository
Id
associated with
this session. Repository Id
associated with this sessionmandatory
- This method must be implemented. Repository getRepository() throws OperationFailedException, PermissionDeniedException
Repository
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForCompositionEnablerNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedRepositoryView()
mandatory
- This method is must be implemented. void useIsolatedRepositoryView()
mandatory
- This method is must be implemented. void reliableCompositionEnablerNotifications()
acknowledgeCompositionEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableCompositionEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeCompositionEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCompositionEnablers() throws OperationFailedException, PermissionDeniedException
CompositionEnablerReceiver.newCompositionEnablers()
is invoked
when a new CompositionEnabler
appears in this
repository.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCompositionEnablers() throws OperationFailedException, PermissionDeniedException
CompositionEnablerReceiver.changedCompositionEnablers()
is
invoked when a composition enabler in this repository is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCompositionEnabler(Id compositionEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedCompositionEnablers()
is invoked
when the specified composition enabler in this repository is changed.compositionEnablerId
- the Id
of the
CompositionEnabler
to monitorNullArgumentException
- compositionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCompositionEnablers() throws OperationFailedException, PermissionDeniedException
CompositionEnablerReceiver.deletedCompositionEnablers()
is
invoked when a composition enabler is deleted or removed from this
repository.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCompositionEnabler(Id compositionEnablerId) throws OperationFailedException, PermissionDeniedException
CompositionEnablerReceiver.deletedCompositionEnablers()
is
invoked when the specified composition enabler is deleted or removed
from this repository.compositionEnablerId
- the Id
of the
CompositionEnabler
to monitorNullArgumentException
- compositionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.