public interface ProcessNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Process
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 |
acknowledgeProcessNotification(Id notificationId)
Acknowledge a process notification.
|
boolean |
canRegisterForProcessNotifications()
Tests if this user can register for
Process
notifications. |
void |
registerForChangedProcess(Id processId)
Registers for notification of an updated process.
|
void |
registerForChangedProcesses()
Registers for notification of updated processes.
|
void |
registerForChangedProcessHierarchy()
Registers for notification of an updated process hierarchy structure.
|
void |
registerForChangedProcessHierarchyForAncestors(Id processId)
Registers for notification of an updated process hierarchy structure.
|
void |
registerForChangedProcessHierarchyForDescendants(Id processId)
Registers for notification of an updated process hierarchy structure.
|
void |
registerForDeletedProcess(Id processId)
Registers for notification of a deleted process.
|
void |
registerForDeletedProcesses()
Registers for notification of deleted processes.
|
void |
registerForNewProcesses()
Register for notifications of new processes.
|
void |
reliableProcessNotifications()
Reliable notifications are desired.
|
void |
unreliableProcessNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForProcessNotifications()
Process
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 reliableProcessNotifications()
acknowledgeProcessNotification()
.mandatory
- This method is must be implemented. void unreliableProcessNotifications()
mandatory
- This method is must be implemented. void acknowledgeProcessNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProcesses() throws OperationFailedException, PermissionDeniedException
ProcessReceiver.newProcesses()
is invoked when a new
Process
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProcesses() throws OperationFailedException, PermissionDeniedException
ProcessReceiver.changedProcesses()
is invoked when a process
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProcess(Id processId) throws OperationFailedException, PermissionDeniedException
ProcessReceiver.changedProcesses()
is invoked when the
specified process is changed.processId
- the Id
of the Process to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProcesses() throws OperationFailedException, PermissionDeniedException
ProcessReceiver.deletedProcesses()
is invoked when a process
is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProcess(Id processId) throws OperationFailedException, PermissionDeniedException
ProcessReceiver.deletedProcesses()
is invoked when the
specified process is deleted.processId
- the Id
of the Process
to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProcessHierarchy() throws OperationFailedException, PermissionDeniedException
ProcessReceiver.changedChildOfProcesses()
is invoked
when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProcessHierarchyForAncestors(Id processId) throws OperationFailedException, PermissionDeniedException
ProcessReceiver.changedChildOfProcesss()
is invoked
when the specified node or any of its ancestors experiences a change
in its children.processId
- the Id
of the Process
node to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProcessHierarchyForDescendants(Id processId) throws OperationFailedException, PermissionDeniedException
ProcessReceiver.changedChildOfProcesses()
is invoked
when the specified node or any of its descendants experiences a change
in its children.processId
- the Id
of the Process
node to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.