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

This session provides methods to retrieve BallotConstrainerEnabler to Polls mappings. A BallotConstrainerEnabler may appear in multiple Polls objects. Each polls may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupBallotConstrainerEnablerPollsMappings
Description

Tests if this user can perform lookups of ballot constrainer enabler/polls mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBallotConstrainerEnablerPollsView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBallotConstrainerEnablerPollsView
Description

A complete view of the BallotConstrainerEnabler and Polls returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetBallotConstrainerEnablerIdsByPolls
Description

Gets the list of BallotConstrainerEnablerIds associated with a Polls.

Parametersosid.id.IdpollsId Id of the Polls
Returnosid.id.IdListlist of related ballot constrainer enabler Ids
ErrorsNOT_FOUND pollsId is not found
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerEnablersByPolls
Description

Gets the list of ballot constrainer enablers associated with a Polls.

Parametersosid.id.IdpollsId Id of the Polls
Returnosid.voting.rules.BallotConstrainerEnablerListlist of related ballot constrainer enablers
ErrorsNOT_FOUND pollsId is not found
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerEnablerIdsByPolls
Description

Gets the list of BallotConstrainerEnabler Ids corresponding to a list of Polls.

Parametersosid.id.IdListpollsIdslist of polls Ids
Returnosid.id.IdListlist of ballot constrainer enabler Ids
ErrorsNULL_ARGUMENT pollsIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerEnablersByPolls
Description

Gets the list of ballot constrainer enablers corresponding to a list of Polls.

Parametersosid.id.IdListpollsIdslist of polls Ids
Returnosid.voting.rules.BallotConstrainerEnablerListlist of ballot constrainer enablers
ErrorsNULL_ARGUMENT pollsIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPollsIdsByBallotConstrainerEnabler
Description

Gets the Polls Ids mapped to a BallotConstrainerEnabler.

Parametersosid.id.IdballotConstrainerEnablerId Id of a BallotConstrainerEnabler
Returnosid.id.IdListlist of polls
ErrorsNOT_FOUND ballotConstrainerEnablerId is not found
NULL_ARGUMENT ballotConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPollsByBallotConstrainerEnabler
Description

Gets the Polls mapped to a BallotConstrainerEnabler.

Parametersosid.id.IdballotConstrainerEnablerId Id of a BallotConstrainerEnabler
Returnosid.voting.PollsListlist of polls
ErrorsNOT_FOUND ballotConstrainerEnablerId is not found
NULL_ARGUMENT ballotConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.