public interface InquestNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Inquest
objects. 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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeInquestNotification(Id notificationId)
Acknowledge an inquest notification.
|
boolean |
canRegisterForInquestNotifications()
Tests if this user can register for
Inquest
notifications. |
void |
registerForChangedInquest(Id inquestId)
Registers for notification of an updated inquest.
|
void |
registerForChangedInquestHierarchy()
Registers for notification of an updated inquest hierarchy structure.
|
void |
registerForChangedInquestHierarchyForAncestors(Id inquestId)
Registers for notification of an updated inquest hierarchy structure.
|
void |
registerForChangedInquestHierarchyForDescendants(Id inquestId)
Registers for notification of an updated inquest hierarchy structure.
|
void |
registerForChangedInquests()
Registers for notification of updated inquests.
|
void |
registerForDeletedInquest(Id inquestId)
Registers for notification of a deleted inquest.
|
void |
registerForDeletedInquests()
Registers for notification of deleted inquests.
|
void |
registerForNewInquests()
Register for notifications of new inquests.
|
void |
reliableInquestNotifications()
Reliable notifications are desired.
|
void |
unreliableInquestNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForInquestNotifications()
Inquest
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 reliableInquestNotifications()
acknowledgeInquestNotification()
.mandatory
- This method is must be implemented. void unreliableInquestNotifications()
mandatory
- This method is must be implemented. void acknowledgeInquestNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewInquests() throws OperationFailedException, PermissionDeniedException
InquestReceiver.newInquests()
is invoked when a new
Inquest
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInquests() throws OperationFailedException, PermissionDeniedException
InquestReceiver.changedInquests()
is invoked when an inquest
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInquest(Id inquestId) throws OperationFailedException, PermissionDeniedException
InquestReceiver.changedInquests()
is invoked when the
specified inquest is changed.inquestId
- the Id of the Inquest
to monitorNullArgumentException
- inquestId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedInquests() throws OperationFailedException, PermissionDeniedException
InquestReceiver.deletedInquests()
is invoked when an inquest
is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedInquest(Id inquestId) throws OperationFailedException, PermissionDeniedException
InquestReceiver.deletedInquests()
is invoked when the
specified inquest is deleted.inquestId
- the Id
of the Inquest
to monitorNullArgumentException
- inquestId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInquestHierarchy() throws OperationFailedException, PermissionDeniedException
InquestReceiver.changedChildOfInquests()
is invoked
when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInquestHierarchyForAncestors(Id inquestId) throws OperationFailedException, PermissionDeniedException
InquestReceiver.changedChildOfInquests()
is invoked
when the specified node or any of its ancestors experiences a change
in its children.inquestId
- the Id
of the Inquest
node to monitorNullArgumentException
- inquestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedInquestHierarchyForDescendants(Id inquestId) throws OperationFailedException, PermissionDeniedException
InquestReceiver.changedChildOfInquests()
is invoked
when the specified node or any of its descendants experiences a change
in its children.inquestId
- the Id
of the Inquest
node to monitorNullArgumentException
- inquestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.