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

This session provides methods to retrieve RaceProcessorEnabler to Polls mappings. a RaceProcessorEnabler 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
MethodcanLookupRaceProcessorEnablerPollsMappings
Description

Tests if this user can perform lookups of race processor 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.
MethoduseComparativeRaceProcessorEnablerPollsView
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.
MethodusePlenaryRaceProcessorEnablerPollsView
Description

A complete view of the RaceProcessorEnabler 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.
MethodgetRaceProcessorEnablerIdsByPolls
Description

Gets the list of RaceProcessorEnablerIds associated with a Polls.

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

Gets the list of race processor enablers associated with a Polls.

Parametersosid.id.IdpollsId Id of the Polls
Returnosid.voting.rules.RaceProcessorEnablerListlist of related race processor 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.
MethodgetRaceProcessorEnablerIdsByPolls
Description

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

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

Gets the list of race processor enablers corresponding to a list of Polls.

Parametersosid.id.IdListpollsIdslist of polls Ids
Returnosid.voting.rules.RaceProcessorEnablerListlist of race processor enablers
ErrorsNULL_ARGUMENT pollsIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPollsIdsByRaceProcessorEnabler
Description

Gets the Polls Ids mapped to a RaceProcessorEnabler.

Parametersosid.id.IdraceProcessorEnablerId Id of a RaceProcessorEnabler
Returnosid.id.IdListlist of polls
ErrorsNOT_FOUND raceProcessorEnablerId is not found
NULL_ARGUMENT raceProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPollsByRaceProcessorEnabler
Description

Gets the Polls mapped to a RaceProcessorEnabler.

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