OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.RaceConstrainerNotificationSession
Implementsosid.OsidSession
Description

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.

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForRaceConstrainerNotifications
Description

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

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 in polls which are children of this 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 to this polls only.

CompliancemandatoryThis method is must be implemented.
MethodreliableRaceConstrainerNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeRaceConstrainerNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableRaceConstrainerNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeRaceConstrainerNotification
Description

Acknowledge a race constrainer notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRaceConstrainers
Description

Register for notifications of new race constrainers. RaceConstrainerReceiver.newRaceConstrainers() is invoked when a new RaceConstrainer appears in this polls.

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

Registers for notification of updated polls. RaceConstrainerReceiver.changedRaceConstrainers() is invoked when a race constrainer in this polls is changed.

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

Registers for notification of an updated race constrainer. ProvisionableReceiver.changedRaceConstrainers() is invoked when the specified race constrainer in this polls is changed.

Parametersosid.id.IdraceConstrainerIdthe Id of the RaceConstrainer to monitor
ErrorsNULL_ARGUMENT raceConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRaceConstrainers
Description

Registers for notification of deleted race constrainers. RaceConstrainerReceiver.deletedRaceConstrainers() is invoked when a race constrainer is deleted or removed from this polls.

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

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

Parametersosid.id.IdraceConstrainerIdthe Id of the RaceConstrainer to monitor
ErrorsNULL_ARGUMENT raceConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.