public interface RaceResultsSession extends OsidSession
This session provides methods for examining voting results.
Modifier and Type | Method and Description |
---|---|
boolean |
canExamineRaceResults()
Tests if this user can examine race results.
|
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
RaceResultList |
getRaceResultsByVoter(Id resourceId)
Gets all race results on this ballot by voter.
|
RaceResultList |
getRaceResultsByVoterForCandidate(Id raceId,
Id candidateId,
Id resourceId)
Gets the race results by voter for a candidate in a race.
|
RaceResultList |
getRaceResultsByVoterForRace(Id raceId,
Id resourceId)
Gets all race results by a resource in a race ordered from the most
votes to the fewest votes.
|
RaceResultList |
getRaceResultsForBalot(Id ballotId)
Gets all race results on a ballot.
|
RaceResultList |
getRaceResultsForCandidate(Id raceId,
Id candidateId)
Gets the race results for a candidate in a race.
|
RaceResultList |
getRaceResultsForRace(Id raceId)
Gets all race results in a race ordered from the most votes to the
fewest votes.
|
RaceResultList |
getTopRaceResultsByVoter(Id resourceId)
Gets the top race results for each race by voter,
|
RaceResultList |
getWinningRaceResultsByVoterForRace(Id raceId,
Id resourceId)
Gets the winning race results by a resource in a race ordered from the
most votes to the fewest votes.
|
RaceResultList |
getWinningRaceResultsForBallot(Id ballotId)
Gets the winning race results for each race on a ballot.
|
RaceResultList |
getWinningRaceResultsForRace(Id raceId)
Gets the winning race results in a race.
|
boolean |
isOpen()
Tests if this ballot is still open.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPollsId()
Polls
Id
associated with this
session. Polls Id
associated with this sessionmandatory
- This method must be implemented. Polls getPolls() throws OperationFailedException, PermissionDeniedException
Polls
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean isOpen()
true
if the ballot is open, false
otherwisemandatory
- This method must be implemented. boolean canExamineRaceResults()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer relationship operations. false
if race results methods are not
authorized, true
otherwisemandatory
- This method must be implemented. RaceResultList getRaceResultsForBalot(Id ballotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ballotId
- Id
of the Ballot
NotFoundException
- ballotId
not foundNullArgumentException
- ballotId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceResultList getWinningRaceResultsForBallot(Id ballotId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ballotId
- Id
of the Ballot
NotFoundException
- ballotId
not foundNullArgumentException
- ballotId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceResultList getRaceResultsForRace(Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceId
- Id
of the Race
NotFoundException
- raceId
not foundNullArgumentException
- raceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceResultList getWinningRaceResultsForRace(Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceId
- Id
of the Race
NotFoundException
- raceId
not foundNullArgumentException
- raceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceResultList getRaceResultsForCandidate(Id raceId, Id candidateId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceId
- Id
of the Race
candidateId
- Id
of the Candidate
NotFoundException
- candidateId
not in
raceId
NullArgumentException
- raceId or
candidateId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceResultList getRaceResultsByVoter(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- Id
of a Resource
NotFoundException
- resourceId
not foundNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceResultList getTopRaceResultsByVoter(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- Id
of a Resource
NotFoundException
- resourceId
not foundNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceResultList getRaceResultsByVoterForRace(Id raceId, Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceId
- Id
of the Race
resourceId
- Id
of a Resource
NotFoundException
- raceId
not foundNullArgumentException
- raceId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceResultList getWinningRaceResultsByVoterForRace(Id raceId, Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceId
- Id
of the Race
resourceId
- Id
of a Resource
NotFoundException
- raceId
not foundNullArgumentException
- raceId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RaceResultList getRaceResultsByVoterForCandidate(Id raceId, Id candidateId, Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceId
- Id
of the Race
candidateId
- Id
of the Candidate
resourceId
- Id
of a Resource
NotFoundException
- candidateId
not in
raceId
NullArgumentException
- raceId,
candidateId or resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented.