public interface ProcessNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Process
objects in this Office.
This also
includes existing process that may appear or disappear due to changes in
the Office
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
ProcessLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForProcessNotifications()
Tests if this user can register for
Process
notifications. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
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 |
registerForDeletedProcesses()
Registers for notification of deleted processes.
|
void |
registerForNewProcesses()
Register for notifications of new processes.
|
void |
useFederatedOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedOfficeView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOfficeId()
Office
Id
associated with this
session. Office Id
associated with this sessionmandatory
- This method must be implemented. Office getOffice() throws OperationFailedException, PermissionDeniedException
Office
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. 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 useFederatedOfficeView()
mandatory
- This method is must be implemented. void useIsolatedOfficeView()
mandatory
- This method is must be implemented. void registerForNewProcesses() throws OperationFailedException, PermissionDeniedException
ProcessReceiver.newProcesses()
is invoked when a new
Process
appears in this office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedProcesses() throws OperationFailedException, PermissionDeniedException
ProcessReceiver.changedProcesses()
is invoked when a process
in this office 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 in this office 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 or removed from this office.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 or removed from this office.processId
- the Id
of the Process
to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.