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 |
---|---|
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 |
registerForDeletedProcess(Id processId)
Registers for notification of a deleted process.
|
void |
registerForDeletedProcessAncestors(Id processId)
Registers for notification if an ancestor is removed from the
specified process in the process hierarchy.
|
void |
registerForDeletedProcessDescendants(Id processId)
Registers for notification if a descendant is removed from fthe
specified process in the process hierarchy.
|
void |
registerForDeletedProcesses()
Registers for notification of deleted processes.
|
void |
registerForNewProcessAncestors(Id processId)
Registers for notification if an ancestor is added to the specified
process in the process hierarchy.
|
void |
registerForNewProcessDescendants(Id processId)
Registers for notification if a descendant is added to the specified
process in the process hierarchy.
|
void |
registerForNewProcesses()
Register for notifications of new processes.
|
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 registerForNewProcesses() throws OperationFailedException, PermissionDeniedException
ProcessReceiver.newProcess()
is invoked when a new
Process
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProcessAncestors(Id processId) throws OperationFailedException, PermissionDeniedException
ProcessReceiver.newProcessAncestor()
is invoked when the
specified process experiences an addition in ancestry.processId
- the Id
of the process to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewProcessDescendants(Id processId) throws OperationFailedException, PermissionDeniedException
ProcessReceiver.newProcessDescendant()
is invoked when the
specified process experiences an addition in descendants.processId
- the Id
of the process to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProcesses() throws OperationFailedException, PermissionDeniedException
ProcessReceiver.changedProcess()
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.changedProcess()
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.deletedProcess()
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.deletedProcess()
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 registerForDeletedProcessAncestors(Id processId) throws OperationFailedException, PermissionDeniedException
ProcessReceiver.deletedProcessAncestor()
is invoked when the
specified process experiences a removal of an ancestor.processId
- the Id
of the process to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedProcessDescendants(Id processId) throws OperationFailedException, PermissionDeniedException
ProcessReceiver.deletedProcessDescednant()
is invoked when the
specified process experiences a removal of one of its descdendents.processId
- the Id
of the process to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.