public interface RaceConstrainerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to RaceConstrainer
objects in this Polls.
This also includes existing RaceConstrainers
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
RaceConstrainerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeRaceConstrainerNotification(Id notificationId)
Acknowledge a race constrainer notification.
|
boolean |
canRegisterForRaceConstrainerNotifications()
Tests if this user can register for
RaceConstrainer
notifications. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
void |
registerForChangedRaceConstrainer(Id raceConstrainerId)
Registers for notification of an updated race constrainer.
|
void |
registerForChangedRaceConstrainers()
Registers for notification of updated polls.
|
void |
registerForDeletedRaceConstrainer(Id raceConstrainerId)
Registers for notification of a deleted race constrainer.
|
void |
registerForDeletedRaceConstrainers()
Registers for notification of deleted race constrainers.
|
void |
registerForNewRaceConstrainers()
Register for notifications of new race constrainers.
|
void |
reliableRaceConstrainerNotifications()
Reliable notifications are desired.
|
void |
unreliableRaceConstrainerNotifications()
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 canRegisterForRaceConstrainerNotifications()
RaceConstrainer
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 reliableRaceConstrainerNotifications()
acknowledgeRaceConstrainerNotification()
.mandatory
- This method is must be implemented. void unreliableRaceConstrainerNotifications()
mandatory
- This method is must be implemented. void acknowledgeRaceConstrainerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRaceConstrainers() throws OperationFailedException, PermissionDeniedException
RaceConstrainerReceiver.newRaceConstrainers()
is invoked when
a new RaceConstrainer
appears in this polls.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRaceConstrainers() throws OperationFailedException, PermissionDeniedException
RaceConstrainerReceiver.changedRaceConstrainers()
is invoked
when a race constrainer in this polls is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRaceConstrainer(Id raceConstrainerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedRaceConstrainers()
is invoked
when the specified race constrainer in this polls is changed.raceConstrainerId
- the Id
of the
RaceConstrainer
to monitorNullArgumentException
- raceConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRaceConstrainers() throws OperationFailedException, PermissionDeniedException
RaceConstrainerReceiver.deletedRaceConstrainers()
is invoked
when a race constrainer is deleted or removed from this polls.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRaceConstrainer(Id raceConstrainerId) throws OperationFailedException, PermissionDeniedException
RaceConstrainerReceiver.deletedRaceConstrainers()
is invoked
when the specified race constrainer is deleted or removed from this
polls.raceConstrainerId
- the Id
of the
RaceConstrainer
to monitorNullArgumentException
- raceConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.