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

This session provides methods to retrieve Candidate to Polls mappings. A Candidate may appear in multiple Polls. 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
MethoduseComparativePollsView
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.
MethodusePlenaryPollsView
Description

A complete view of the Candidate 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.
MethodcanLookupCandidatePollsMappings
Description

Tests if this user can perform lookups of candidate/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.
MethodgetCandidateIdsByPolls
Description

Gets the list of Candidate Ids associated with a Polls.

Parametersosid.id.IdpollsId Id of a Polls
Returnosid.id.IdListlist of related candidate 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.
MethodgetCandidatesByPolls
Description

Gets the list of Candidates associated with a Polls.

Parametersosid.id.IdpollsId Id of a Polls
Returnosid.voting.CandidateListlist of related candidates
ErrorsNOT_FOUND pollsId is not found
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCandidateIdsByPolls
Description

Gets the list of Candidate Ids corresponding to a list of Polls objects.

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

Gets the list of Candidates corresponding to a list of Polls.

Parametersosid.id.IdListpollsIdslist of polls Ids
Returnosid.voting.CandidateListlist of candidates
ErrorsNULL_ARGUMENT pollsIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPollsIdsByCandidate
Description

Gets the list of Polls Ids mapped to a Candidate.

Parametersosid.id.IdcandidateId Id of a Candidate
Returnosid.id.IdListlist of polls Ids
ErrorsNOT_FOUND candidateId is not found
NULL_ARGUMENT candidateId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPollsByCandidate
Description

Gets the list of Polls objects mapped to a Candidate.

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