Interface RaceResultsSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RaceResultsSession
extends OsidSession

This session provides methods for examining voting results.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getPollsId

Id getPollsId()

Gets the Polls Id associated with this session.

Returns:

the Polls Id associated with this session

Compliance:

mandatory - This method must be implemented.

getPolls

Polls getPolls()
        throws OperationFailedException,
PermissionDeniedException

Gets the Polls associated with this session.

Returns:

the polls

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isOpen

boolean isOpen()

Tests if this ballot is still open.

Returns:

true if the ballot is open, false otherwise

Compliance:

mandatory - This method must be implemented.

canExamineRaceResults

boolean canExamineRaceResults()

Tests if this user can examine race results. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer relationship operations.

Returns:

false if race results methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getRaceResultsForBalot

RaceResultList getRaceResultsForBalot(Id ballotId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all race results on a ballot.

Parameters:

ballotId - Id of the Ballot

Returns:

the race results

Throws:

NotFoundException - ballotId not found

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getWinningRaceResultsForBallot

RaceResultList getWinningRaceResultsForBallot(Id ballotId)
                                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the winning race results for each race on a ballot.

Parameters:

ballotId - Id of the Ballot

Returns:

the race results

Throws:

NotFoundException - ballotId not found

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRaceResultsForRace

RaceResultList getRaceResultsForRace(Id raceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all race results in a race ordered from the most votes to the fewest votes.

Parameters:

raceId - Id of the Race

Returns:

the race results

Throws:

NotFoundException - raceId not found

NullArgumentException - raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getWinningRaceResultsForRace

RaceResultList getWinningRaceResultsForRace(Id raceId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the winning race results in a race.

Parameters:

raceId - Id of the Race

Returns:

the race results

Throws:

NotFoundException - raceId not found

NullArgumentException - raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRaceResultsForCandidate

RaceResultList getRaceResultsForCandidate(Id raceId,
 Id candidateId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the race results for a candidate in a race.

Parameters:

raceId - Id of the Race

candidateId - Id of the Candidate

Returns:

the race results

Throws:

NotFoundException - candidateId not in raceId

NullArgumentException - raceId or candidateId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRaceResultsByVoter

RaceResultList getRaceResultsByVoter(Id resourceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all race results on this ballot by voter.

Parameters:

resourceId - Id of a Resource

Returns:

the race results

Throws:

NotFoundException - resourceId not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getTopRaceResultsByVoter

RaceResultList getTopRaceResultsByVoter(Id resourceId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the top race results for each race by voter,

Parameters:

resourceId - Id of a Resource

Returns:

the race results

Throws:

NotFoundException - resourceId not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRaceResultsByVoterForRace

RaceResultList getRaceResultsByVoterForRace(Id raceId,
 Id resourceId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all race results by a resource in a race ordered from the most votes to the fewest votes.

Parameters:

raceId - Id of the Race

resourceId - Id of a Resource

Returns:

the race results

Throws:

NotFoundException - raceId not found

NullArgumentException - raceId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getWinningRaceResultsByVoterForRace

RaceResultList getWinningRaceResultsByVoterForRace(Id raceId,
 Id resourceId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the winning race results by a resource in a race ordered from the most votes to the fewest votes.

Parameters:

raceId - Id of the Race

resourceId - Id of a Resource

Returns:

the race results

Throws:

NotFoundException - raceId not found

NullArgumentException - raceId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRaceResultsByVoterForCandidate

RaceResultList getRaceResultsByVoterForCandidate(Id raceId,
 Id candidateId,
 Id resourceId)
                                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the race results by voter for a candidate in a race.

Parameters:

raceId - Id of the Race

candidateId - Id of the Candidate

resourceId - Id of a Resource

Returns:

the race results

Throws:

NotFoundException - candidateId not in raceId

NullArgumentException - raceId , candidateId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.