public interface RaceResult extends OsidCompendium
The results for a candidate in a race.
Modifier and Type | Method and Description |
---|---|
Candidate |
getCandidate()
Gets the
Candidate. |
Id |
getCandidateId()
Gets the candidate
Id. |
java.math.BigDecimal |
getMeanVotes()
Gets the mean number of votes cast for this candidate.
|
long |
getMedianVotes()
Gets the median number of votes cast for this candidate.
|
Race |
getRace()
Gets the race of the vote.
|
Id |
getRaceId()
Geta the race
Id of the vote. |
RaceResultRecord |
getRaceResultRecord(Type raceResultsRecordType)
Gets the race result record corresponding to the given
RaceResults record Type. |
Resource |
getResource()
Gets the
Resource. |
Id |
getResourceId()
Gets the resource
Id . |
long |
getTotalVotes()
Gets the total number of votes cast for this candidate.
|
java.math.BigDecimal |
getVoteStandardDeviation()
Gets the standard deviation of the votes.
|
boolean |
isFinal()
Tests if these results are final.
|
getEndDate, getStartDate, isExtrapolated, isInterpolated
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getRaceId()
Id
of the vote. Id
mandatory
- This method must be implemented. Race getRace() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getCandidateId()
Id.
Id
mandatory
- This method must be implemented. Candidate getCandidate() throws OperationFailedException
Candidate.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getResourceId()
Id
. A resource represents a voter or
group of voters across a demographic. Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
Resource.
A resource represents a voter or
group of voters across a demographic.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isFinal()
true
if these results are final, false
otherwisemandatory
- This method must be implemented. long getTotalVotes()
mandatory
- This method must be implemented. java.math.BigDecimal getMeanVotes()
mandatory
- This method must be implemented. long getMedianVotes()
mandatory
- This method must be implemented. java.math.BigDecimal getVoteStandardDeviation()
mandatory
- This method must be implemented. RaceResultRecord getRaceResultRecord(Type raceResultsRecordType) throws OperationFailedException
RaceResults
record Type.
This method is used to
retrieve an object implementing the requested record. The
raceResultsRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(raceResultsRecordType)
is true
.raceResultsRecordType
- the type of the record to retrieveNullArgumentException
- raceResultsRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(raceResultsRecordType)
is false
mandatory
- This method must be implemented.