org.osid.voting

Interface Race

All Superinterfaces:

Aggregateable, Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject, Sourceable, Subjugateable

public interface Race
extends OsidGovernator, Aggregateable, Subjugateable

An Race defines a competition among Candidates.

Method Summary

Methods

Modifier and Type	Method and Description
Ballot	getBallot() Gets the ballot.
Id	getBallotId() Gets the ballot Id .
IdList	getCandidateIds() Gets the candidate Ids in this race.
CandidateList	getCandidates() Gets the candidates in this race.
RaceRecord	getRaceRecord(Type raceRecordType) Gets the race record corresponding to the given Pollstem record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getBallotId

Id getBallotId()

Gets the ballot Id .

Returns:

the ballot Id

Compliance:

mandatory - This method must be implemented.

getBallot

Ballot getBallot()
                 throws OperationFailedException

Gets the ballot.

Returns:

the ballot

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCandidateIds

IdList getCandidateIds()

Gets the candidate Ids in this race.

Returns:

the candidate Ids

Compliance:

mandatory - This method must be implemented.

getCandidates

CandidateList getCandidates()
                            throws OperationFailedException

Gets the candidates in this race.

Returns:

the candidate list

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getRaceRecord

RaceRecord getRaceRecord(Type raceRecordType)
                         throws OperationFailedException

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

Parameters:

raceRecordType - the race record type

Returns:

the race record

Throws:

NullArgumentException - raceRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceRecordType) is false

Compliance:

mandatory - This method must be implemented.