public interface StepNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Step
objects in this Office.
This also
includes existing steps 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
StepLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForStepNotifications()
Tests if this user can register for
Step notifications. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
void |
registerForChangedStep(Id stepId)
Registers for notification of an updated step.
|
void |
registerForChangedSteps()
Registers for notification of updated steps.
|
void |
registerForChangedStepsForProcess(Id processId)
Register for notifications of updated steps for the given process
Id. |
void |
registerForDeletedStep(Id stepId)
Registers for notification of a deleted step.
|
void |
registerForDeletedSteps()
Registers for notification of deleted steps.
|
void |
registerForDeletedStepsForProcess(Id processId)
Register for notifications of deleted steps for the given process
Id. |
void |
registerForNewSteps()
Register for notifications of new steps.
|
void |
registerForNewStepsForProcess(Id processId)
Register for notifications of new steps in the given process
Id. |
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 canRegisterForStepNotifications()
Step
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 registerForNewSteps() throws OperationFailedException, PermissionDeniedException
StepReceiver.newSteps()
is invoked when a new Step
appears in this office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewStepsForProcess(Id processId) throws OperationFailedException, PermissionDeniedException
Id.
StepReceiver.newSteps()
is invoked when a
new Step
is created.processId
- the Id
of the process to monitorNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSteps() throws OperationFailedException, PermissionDeniedException
StepReceiver.changedSteps()
is invoked when a step in this
office is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedStepsForProcess(Id processId) throws OperationFailedException, PermissionDeniedException
Id.
StepReceiver.changedSteps()
is
invoked when a step 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 registerForChangedStep(Id stepId) throws OperationFailedException, PermissionDeniedException
StepReceiver.changedSteps()
is invoked when the specified step
in this office is changed.stepId
- the Id
of the Step
to
monitorNullArgumentException
- stepId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSteps() throws OperationFailedException, PermissionDeniedException
StepReceiver.deletedSteps()
is invoked when a step is deleted
or removed from this office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedStepsForProcess(Id processId) throws OperationFailedException, PermissionDeniedException
Id.
StepReceiver.deletedSteps()
is
invoked when a step in this office is removed or 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 registerForDeletedStep(Id stepId) throws OperationFailedException, PermissionDeniedException
StepReceiver.deletedSteps()
is invoked when the specified step
is deleted or removed from this office.stepId
- the Id
of the Step
to
monitorNullArgumentException
- stepId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.