public interface WorkflowEventNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to WorkflowEvent
objects in this Process.
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 |
canRegisterForWorkflowEventNotifications()
Tests if this user can register for
WorkflowEvent
notifications. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
void |
registerForNewWorkflowEvents()
Register for notifications of new workflow events.
|
void |
registerForNewWorkflowEventsForProcess(Id processId)
Register for notifications of new workflow events for the given
process.
|
void |
registerForNewWorkflowEventsForStep(Id stepId)
Register for notifications of new workflow events for the given step.
|
void |
registerForNewWorkflowEventsForWork(Id workId)
Register for notifications of new workflow events for the given work.
|
void |
registerForNewWorkflowEventsForWorker(Id resourceId)
Register for notifications of new workflow events for the given
resource.
|
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. void useFederatedOfficeView()
mandatory
- This method is must be implemented. void useIsolatedOfficeView()
mandatory
- This method is must be implemented. boolean canRegisterForWorkflowEventNotifications()
WorkflowEvent
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 registerForNewWorkflowEvents() throws OperationFailedException, PermissionDeniedException
WorkflowEventReceiver.newWorkflowEvent()
is invoked when a new
WorkflowEvent
appears in this process.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewWorkflowEventsForProcess(Id processId) throws OperationFailedException, PermissionDeniedException
WorkflowEventReceiver.newWorkflowEvent()
is
invoked when a new WorkflowEvent
appears in this
process.processId
- the Id
of the Process
to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewWorkflowEventsForStep(Id stepId) throws OperationFailedException, PermissionDeniedException
WorkflowEventReceiver.newWorkflowEvent()
is invoked
when a new WorkflowEvent
appears in this process.stepId
- the Id
of the Step
to
monitorNullArgumentException
- stepId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewWorkflowEventsForWork(Id workId) throws OperationFailedException, PermissionDeniedException
WorkflowEventReceiver.newWorkflowEvent()
is invoked
when a new WorkflowEvent
appears in this process.workId
- the Id
of the Work
to
monitorNullArgumentException
- workId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewWorkflowEventsForWorker(Id resourceId) throws OperationFailedException, PermissionDeniedException
WorkflowEventReceiver.newWorkflowEvent()
is
invoked when a new WorkflowEvent
appears in this
process.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.