public interface HoldEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to HoldEnabler
objects in this Hold.
This
also includes existing HoldEnablers
that may appear or
disappear due to changes in the Hold
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
HoldEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeHoldEnablerNotification(Id notificationId)
Acknowledge a hold enabler notification.
|
boolean |
canRegisterForHoldEnablerNotifications()
Tests if this user can register for
HoldEnabler
notifications. |
Oubliette |
getOubliette()
Gets the
Oubliette associated with this session. |
Id |
getOublietteId()
Gets the
Oubliette Id associated with
this session. |
void |
registerForChangedHoldEnabler(Id holdEnablerId)
Registers for notification of an updated hold enabler.
|
void |
registerForChangedHoldEnablers()
Registers for notification of updated hold enablers.
|
void |
registerForDeletedHoldEnabler(Id holdEnablerId)
Registers for notification of a deleted hold enabler.
|
void |
registerForDeletedHoldEnablers()
Registers for notification of deleted hold enablers.
|
void |
registerForNewHoldEnablers()
Register for notifications of new hold enablers.
|
void |
reliableHoldEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableHoldEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedOublietteView()
Federates the view for methods in this session.
|
void |
useIsolatedOublietteView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOublietteId()
Oubliette
Id
associated with
this session. Oubliette Id
associated with this sessionmandatory
- This method must be implemented. Oubliette getOubliette() throws OperationFailedException, PermissionDeniedException
Oubliette
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForHoldEnablerNotifications()
HoldEnabler
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 useFederatedOublietteView()
mandatory
- This method is must be implemented. void useIsolatedOublietteView()
mandatory
- This method is must be implemented. void reliableHoldEnablerNotifications()
acknowledgeHoldEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableHoldEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeHoldEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewHoldEnablers() throws OperationFailedException, PermissionDeniedException
HoldEnablerReceiver.newHoldEnablers()
is invoked when a new
HoldEnabler
appears in this oubliette.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedHoldEnablers() throws OperationFailedException, PermissionDeniedException
HoldEnablerReceiver.changedHoldEnablers()
is invoked when a
hold enabler in this oubliette is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedHoldEnabler(Id holdEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedHoldEnablers()
is invoked when
the specified hold enabler in this oubliette is changed.holdEnablerId
- the Id
of the HoldEnabler
to monitorNullArgumentException
- holdEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedHoldEnablers() throws OperationFailedException, PermissionDeniedException
HoldEnablerReceiver.deletedHoldEnablers()
is invoked when a
hold enabler is deleted or removed from this oubliette.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedHoldEnabler(Id holdEnablerId) throws OperationFailedException, PermissionDeniedException
HoldEnablerReceiver.deletedHoldEnablers()
is invoked when the
specified hold enabler is deleted or removed from this oubliette.holdEnablerId
- the Id
of the HoldEnabler
to monitorNullArgumentException
- holdEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.