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

A Candidate represents a voting option in a race. A Candidate is a relationship between a Resource and a Race.

MethodgetRaceId
Description

Gets the race Id of the candidate.

Returnosid.id.Idthe candidate Id
CompliancemandatoryThis method must be implemented.
MethodgetRace
Description

Gets the race of the candidate.

Returnosid.voting.Racethe race
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetResourceId
Description

Gets the resource Id related to the candidate.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource related to the candidate.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCandidateRecord
Description

Gets the candidate record corresponding to the given Candidate record Type. This method is used to retrieve an object implementing the requested record. The candidateRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(candidateRecordType) is true .

Parametersosid.type.TypecandidateRecordTypethe candidate record type
Returnosid.voting.records.CandidateRecordthe candidate record
ErrorsNULL_ARGUMENT candidateRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(candidateRecordType) is false
CompliancemandatoryThis method must be implemented.