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

This session provides methods to retrieve Race to Polls mappings. A Race may appear in multiple Polls objects. Each catalog 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
MethodcanLookupRacePollsMappings
Description

Tests if this user can perform lookups of race/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.
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 Race 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.
MethodgetRaceIdsByPolls
Description

Gets the list of Race Ids associated with a Polls.

Parametersosid.id.IdpollsId Id of the Polls
Returnosid.id.IdListlist of related race 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.
MethodgetRacesByPolls
Description

Gets the list of Races associated with a Polls.

Parametersosid.id.IdpollsId Id of the Polls
Returnosid.voting.RaceListlist of related races
ErrorsNOT_FOUND pollsId is not found
NULL_ARGUMENT pollsId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRaceIdsByPolls
Description

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

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

Gets the list of Races corresponding to a list of Polls objects.

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

Gets the Polls Ids mapped to a Race.

Parametersosid.id.IdraceId Id of a Race
Returnosid.id.IdListlist of polls Ids
ErrorsNOT_FOUND raceId is not found
NULL_ARGUMENT raceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPollsByRace
Description

Gets the Polls objects mapped to a Race.

Parametersosid.id.IdraceId Id of a Race
Returnosid.voting.PollsListlist of polls Ids
ErrorsNOT_FOUND raceId is not found
NULL_ARGUMENT raceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.