OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.RaceNotificationSession
Implementsosid.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.

MethodgetPollsId
Description

Gets the Polls Id associated with this session.

Returnosid.id.Idthe Polls Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPolls
Description

Gets the Polls associated with this session.

Returnosid.voting.Pollsthe Polls associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForRaceNotifications
Description

Tests if this user can register for Race 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedPollsView
Description

Federates the view for methods in this session. A federated view will include races from parent polls in the polls hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedPollsView
Description

Isolates the view for methods in this session. An isolated view restricts notifications for races to this polls only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewRaces
Description

Register for notifications of new races. RaceReceiver.newRaces() is invoked when a new Race is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRacesForBallot
Description

Register for notifications of new races for a ballot. RaceReceiver.newRaces() is invoked when a new Race is created.

Parametersosid.id.IdballotIdthe Id of the Ballot to monitor
ErrorsNULL_ARGUMENT ballotId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRaces
Description

Register for notifications of new races. RaceReceiver.changedRaces() is invoked when a Race is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRacesForBallot
Description

Registers for notification of updated races for a ballot. RaceReceiver.changedRaces() is invoked when the specified race in this polls is changed.

Parametersosid.id.IdballotIdthe Id of the Ballot to monitor
ErrorsNULL_ARGUMENT ballotId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRace
Description

Registers for notification of an updated race. RaceReceiver.changedRaces() is invoked when the specified race in this polls is changed.

Parametersosid.id.IdraceIdthe Id of the Race to monitor
ErrorsNULL_ARGUMENT raceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRaces
Description

Registers for notification of deleted races. RaceReceiver.deletedRaces() is invoked when a race is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRacesForBallot
Description

Registers for notification of deleted races for ballot. RaceReceiver.deletedRaces() is invoked when the specified race is deleted or removed from this polls.

Parametersosid.id.IdballotIdthe Id of the Ballot to monitor
ErrorsNULL_ARGUMENT ballotId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRace
Description

Registers for notification of a deleted race. RaceReceiver.deletedRaces() is invoked when the specified race is deleted or removed from this polls.

Parametersosid.id.IdraceIdthe Id of the Race to monitor
ErrorsNULL_ARGUMENT raceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.