public interface RaceProcessorNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to RaceProcessor
objects in this Polls.
This
also includes existing RaceProcessors
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
RaceProcessorLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeRaceProcessorNotification(Id notificationId)
Acknowledge a race processor notification.
|
boolean |
canRegisterForRaceProcessorNotifications()
Tests if this user can register for
RaceProcessor
notifications. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
void |
registerForChangedRaceProcessor(Id raceProcessorId)
Registers for notification of an updated race processor.
|
void |
registerForChangedRaceProcessors()
Registers for notification of updated polls.
|
void |
registerForDeletedRaceProcessor(Id raceProcessorId)
Registers for notification of a deleted race processor.
|
void |
registerForDeletedRaceProcessors()
Registers for notification of deleted race processors.
|
void |
registerForNewRaceProcessors()
Register for notifications of new race processors.
|
void |
reliableRaceProcessorNotifications()
Reliable notifications are desired.
|
void |
unreliableRaceProcessorNotifications()
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 canRegisterForRaceProcessorNotifications()
RaceProcessor
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 reliableRaceProcessorNotifications()
acknowledgeRaceProcessorNotification()
.mandatory
- This method is must be implemented. void unreliableRaceProcessorNotifications()
mandatory
- This method is must be implemented. void acknowledgeRaceProcessorNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRaceProcessors() throws OperationFailedException, PermissionDeniedException
RaceProcessorReceiver.newRaceProcessors()
is invoked when a
new RaceProcessor
appears in this polls.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRaceProcessors() throws OperationFailedException, PermissionDeniedException
RaceProcessorReceiver.changedRaceProcessors()
is invoked when
a race processor in this polls is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRaceProcessor(Id raceProcessorId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedRaceProcessors()
is invoked when
the specified race processor in this polls is changed.raceProcessorId
- the Id
of the
RaceProcessor
to monitorNullArgumentException
- raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRaceProcessors() throws OperationFailedException, PermissionDeniedException
RaceProcessorReceiver.deletedRaceProcessors()
is invoked when
a race processor is deleted or removed from this polls.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRaceProcessor(Id raceProcessorId) throws OperationFailedException, PermissionDeniedException
RaceProcessorReceiver.deletedRaceProcessors()
is invoked when
the specified race processor is deleted or removed from this polls.raceProcessorId
- the Id
of the
RaceProcessor
to monitorNullArgumentException
- raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.