public interface RaceProcessorEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to RaceProcessorEnabler
objects in this Polls.
This also includes existing RaceProcessorEnablers
that may appear or disappear due to changes in the Polls
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
RaceProcessorEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeRaceProcessorEnablerNotification(Id notificationId)
Acknowledge a race processor enabler notification.
|
boolean |
canRegisterForRaceProcessorEnablerNotifications()
Tests if this user can register for
RaceProcessorEnabler
notifications. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
void |
registerForChangedRaceProcessorEnabler(Id raceProcessorEnablerId)
Registers for notification of an updated race processor enabler.
|
void |
registerForChangedRaceProcessorEnablers()
Registers for notification of updated polls enabelrs.
|
void |
registerForDeletedRaceProcessorEnabler(Id raceProcessorEnablerId)
Registers for notification of a deleted race processor enabler.
|
void |
registerForDeletedRaceProcessorEnablers()
Registers for notification of deleted race processor enablers.
|
void |
registerForNewRaceProcessorEnablers()
Register for notifications of new race processor enablers.
|
void |
reliableRaceProcessorEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableRaceProcessorEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedPollsView()
Federates the view for methods in this session.
|
void |
useIsolatedPollsView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPollsId()
Polls
Id
associated with this
session. Polls Id
associated with this sessionmandatory
- This method must be implemented. Polls getPolls() throws OperationFailedException, PermissionDeniedException
Polls
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForRaceProcessorEnablerNotifications()
RaceProcessorEnabler
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 useFederatedPollsView()
mandatory
- This method is must be implemented. void useIsolatedPollsView()
mandatory
- This method is must be implemented. void reliableRaceProcessorEnablerNotifications()
acknowledgeRaceProcessorEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableRaceProcessorEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeRaceProcessorEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRaceProcessorEnablers() throws OperationFailedException, PermissionDeniedException
RaceProcessorEnablerReceiver.newRaceProcessorEnablers()
is
invoked when a new RaceProcessorEnabler
appears in this
polls.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRaceProcessorEnablers() throws OperationFailedException, PermissionDeniedException
RaceProcessorEnablerReceiver.changedRaceProcessorEnablers()
is
invoked when a race processor enabler in this polls is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRaceProcessorEnabler(Id raceProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedRaceProcessorEnablers()
is
invoked when the specified race processor enabler in this polls is
changed.raceProcessorEnablerId
- the Id
of the
RaceProcessorEnabler
to monitorNullArgumentException
- raceProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRaceProcessorEnablers() throws OperationFailedException, PermissionDeniedException
RaceProcessorEnablerReceiver.deletedRaceProcessorEnablers()
is
invoked when a race processor enabler is deleted or removed from this
polls.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRaceProcessorEnabler(Id raceProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
RaceProcessorEnablerReceiver.deletedRaceProcessorEnablers()
is
invoked when the specified race processor enabler is deleted or
removed from this polls.raceProcessorEnablerId
- the Id
of the
RaceProcessorEnabler
to monitorNullArgumentException
- raceProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.