public interface StepProcessorEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to StepProcessorEnabler
objects in this Office.
This also includes existing StepProcessorEnablers
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
StepProcessorEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeStepProcessorEnablerNotification(Id notificationId)
Acknowledge a step processor enabler notification.
|
boolean |
canRegisterForStepProcessorEnablerNotifications()
Tests if this user can register for
StepProcessorEnabler
notifications. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
void |
registerForChangedStepProcessorEnabler(Id stepProcessorEnablerId)
Registers for notification of an updated step processor enabler.
|
void |
registerForChangedStepProcessorEnablers()
Registers for notification of updated office enabelrs.
|
void |
registerForDeletedStepProcessorEnabler(Id stepProcessorEnablerId)
Registers for notification of a deleted step processor enabler.
|
void |
registerForDeletedStepProcessorEnablers()
Registers for notification of deleted step processor enablers.
|
void |
registerForNewStepProcessorEnablers()
Register for notifications of new step processor enablers.
|
void |
reliableStepProcessorEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableStepProcessorEnablerNotifications()
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 canRegisterForStepProcessorEnablerNotifications()
StepProcessorEnabler
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 reliableStepProcessorEnablerNotifications()
acknowledgeStepProcessorEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableStepProcessorEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeStepProcessorEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewStepProcessorEnablers() throws OperationFailedException, PermissionDeniedException
StepProcessorEnablerReceiver.newStepProcessorEnablers()
is
invoked when a new StepProcessorEnabler
appears in this
office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedStepProcessorEnablers() throws OperationFailedException, PermissionDeniedException
StepProcessorEnablerReceiver.changedStepProcessorEnablers()
is
invoked when a step processor enabler in this office is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedStepProcessorEnabler(Id stepProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedStepProcessorEnablers()
is
invoked when the specified step processor enabler in this office is
changed.stepProcessorEnablerId
- the Id
of the
StepProcessorEnabler
to monitorNullArgumentException
- stepProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedStepProcessorEnablers() throws OperationFailedException, PermissionDeniedException
StepProcessorEnablerReceiver.deletedStepProcessorEnablers()
is
invoked when a step processor enabler is deleted or removed from this
office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedStepProcessorEnabler(Id stepProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
StepProcessorEnablerReceiver.deletedStepProcessorEnablers()
is
invoked when the specified step processor enabler is deleted or
removed from this office.stepProcessorEnablerId
- the Id
of the
StepProcessorEnabler
to monitorNullArgumentException
- stepProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.