Interface | osid.voting.RaceNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on new or deleted races. 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. This session registers notifications for the Race itself. | ||
Method | getPollsId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Polls Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getPolls | ||
Description |
Gets the | ||
Return | osid.voting.Polls | the Polls associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForRaceNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedPollsView | ||
Description |
Federates the view for methods in this session. A federated view will include races from parent polls in the polls hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedPollsView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications for races to this polls only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewRaces | ||
Description |
Register for notifications of new races. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewRacesForBallot | ||
Description |
Register for notifications of new races for a ballot.
| ||
Parameters | osid.id.Id | ballotId | the Id of the Ballot to monitor |
Errors | NULL_ARGUMENT | ballotId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRaces | ||
Description |
Register for notifications of new races. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRacesForBallot | ||
Description |
Registers for notification of updated races for a
ballot. | ||
Parameters | osid.id.Id | ballotId | the Id of the Ballot to monitor |
Errors | NULL_ARGUMENT | ballotId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRace | ||
Description |
Registers for notification of an updated race. | ||
Parameters | osid.id.Id | raceId | the Id of the Race to monitor |
Errors | NULL_ARGUMENT | raceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRaces | ||
Description |
Registers for notification of deleted races. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRacesForBallot | ||
Description |
Registers for notification of deleted races for ballot.
| ||
Parameters | osid.id.Id | ballotId | the Id of the Ballot to monitor |
Errors | NULL_ARGUMENT | ballotId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRace | ||
Description |
Registers for notification of a deleted race. | ||
Parameters | osid.id.Id | raceId | the Id of the Race to monitor |
Errors | NULL_ARGUMENT | raceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |