public interface Candidate extends OsidRelationship
A Candidate
represents a voting option in a race. A
Candidate
is a relationship between a Resource
and a Race.
Modifier and Type | Method and Description |
---|---|
CandidateRecord |
getCandidateRecord(Type candidateRecordType)
Gets the candidate record corresponding to the given
Candidate
record Type. |
Race |
getRace()
Gets the race of the candidate.
|
Id |
getRaceId()
Gets the race
Id of the candidate. |
Resource |
getResource()
Gets the resource related to the candidate.
|
Id |
getResourceId()
Gets the resource
Id related to the candidate. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getRaceId()
Id
of the candidate. Id
mandatory
- This method must be implemented. Race getRace() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getResourceId()
Id
related to the candidate. Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CandidateRecord getCandidateRecord(Type candidateRecordType) throws OperationFailedException
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
.candidateRecordType
- the candidate record typeNullArgumentException
- candidateRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(candidateRecordType)
is false
mandatory
- This method must be implemented.