public interface StepProcessorNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to StepProcessor
objects in this Office.
This also includes existing StepProcessors
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
StepProcessorLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeStepProcessorNotification(Id notificationId)
Acknowledge a step processor notification.
|
boolean |
canRegisterForStepProcessorNotifications()
Tests if this user can register for
StepProcessor
notifications. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
void |
registerForChangedStepProcessor(Id stepProcessorId)
Registers for notification of an updated step processor.
|
void |
registerForChangedStepProcessors()
Registers for notification of updated office.
|
void |
registerForDeletedStepProcessor(Id stepProcessorId)
Registers for notification of a deleted step processor.
|
void |
registerForDeletedStepProcessors()
Registers for notification of deleted step processors.
|
void |
registerForNewStepProcessors()
Register for notifications of new step processors.
|
void |
reliableStepProcessorNotifications()
Reliable notifications are desired.
|
void |
unreliableStepProcessorNotifications()
Unreliable notifications are desired.
|
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 canRegisterForStepProcessorNotifications()
StepProcessor
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 reliableStepProcessorNotifications()
acknowledgeStepProcessorNotification()
.mandatory
- This method is must be implemented. void unreliableStepProcessorNotifications()
mandatory
- This method is must be implemented. void acknowledgeStepProcessorNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewStepProcessors() throws OperationFailedException, PermissionDeniedException
StepProcessorReceiver.newStepProcessors()
is invoked when a
new StepProcessor
appears in this office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedStepProcessors() throws OperationFailedException, PermissionDeniedException
StepProcessorReceiver.changedStepProcessors()
is invoked when
a step processor in this office is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedStepProcessor(Id stepProcessorId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedStepProcessors()
is invoked when
the specified step processor in this office is changed.stepProcessorId
- the Id
of the
StepProcessor
to monitorNullArgumentException
- stepProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedStepProcessors() throws OperationFailedException, PermissionDeniedException
StepProcessorReceiver.deletedStepProcessors()
is invoked when
a step processor is deleted or removed from this office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedStepProcessor(Id stepProcessorId) throws OperationFailedException, PermissionDeniedException
StepProcessorReceiver.deletedStepProcessors()
is invoked when
the specified step processor is deleted or removed from this office.stepProcessorId
- the Id
of the
StepProcessor
to monitorNullArgumentException
- stepProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.