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

This session defines methods to receive notifications on adds/changes to BallotConstrainerEnabler objects in this Polls. This also includes existing BallotConstrainerEnablers 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 BallotConstrainerEnablerLookupSession.

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.
MethodcanRegisterForBallotConstrainerEnablerNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableBallotConstrainerEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeBallotConstrainerEnablerNotification
Description

Acknowledge a ballot constrainer enabler notification.

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

Register for notifications of new ballot constrainer enablers. BallotConstrainerEnablerReceiver.newBallotConstrainerEnablers() is invoked when a new BallotConstrainerEnabler appears in this polls.

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

Registers for notification of updated polls enabelrs. BallotConstrainerEnablerReceiver.changedBallotConstrainerEnablers() is invoked when a ballot constrainer enabler in this polls is changed.

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

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

Parametersosid.id.IdballotConstrainerEnablerIdthe Id of the BallotConstrainerEnabler to monitor
ErrorsNULL_ARGUMENT ballotConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedBallotConstrainerEnablers
Description

Registers for notification of deleted ballot constrainer enablers. BallotConstrainerEnablerReceiver.deletedBallotConstrainerEnablers() is invoked when a ballot constrainer enabler is deleted or removed from this polls.

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

Registers for notification of a deleted ballot constrainer enabler. BallotConstrainerEnablerReceiver.deletedBallotConstrainerEnablers() is invoked when the specified ballot constrainer enabler is deleted or removed from this polls.

Parametersosid.id.IdballotConstrainerEnablerIdthe Id of the BallotConstrainerEnabler to monitor
ErrorsNULL_ARGUMENT ballotConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.