Interface VotingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

VotingBatchSession

public interface VotingSession
extends OsidSession

This session provides methods for voting on a ballot.

Method Summary

Modifier and Type	Method	Description
boolean	canRevote(Id ballotId)	Tests if this user can change a vote by deleting a vote and voting again.
boolean	canVote()	Tests if this user can vote.
boolean	canVoteWithRecordTypes(Id raceId, Type[] voteRecordTypes)	Tests if this user can create a single Vote using the desired record interface types.
void	deleteMyVote(Id voteId)	Deletes a vote in a race.
RaceList	getMyUncastRacesForBallot(Id ballotId)	Gets all Races on this ballot for which a vote has not been cast.
VoteList	getMyVotesForBallot(Id ballotId)	Gets all my Votes cast on a ballot.
VoteList	getMyVotesForRace(Id raceId)	Gets all my Votes cast on this ballot for the given race.
Polls	getPolls()	Gets the Polls associated with this session.
Id	getPollsId()	Gets the Polls Id associated with this session.
Race	getRace(Id raceId)	Gets a race.
RaceList	getRacesForBallot(Id ballotId)	Gets all Races on this ballot.
VoteForm	getVoteForm(Id raceId, Id candidateId, Type[] voteRecordTypes)	Gets a vote form for a race.
VoterAllocation	getVotingAllocation(Id raceId)	Gets the voter allocation for a race.
boolean	isOpen()	Tests if this ballot is open.
Vote	vote(VoteForm voteForm)	Votes for a candidate in a race.

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 open.

Returns:

true if the ballot is open, false otherwise

Compliance:

mandatory - This method must be implemented.

canVote

boolean canVote()

Tests if this user can vote. 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 voting methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getRace

Race getRace(Id raceId)
      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a race.

Parameters:

raceId - Id of the Race

Returns:

the race

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.

getRacesForBallot

RaceList getRacesForBallot(Id ballotId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all Races on this ballot.

Parameters:

ballotId - Id of the Ballot

Returns:

the races

Throws:

NotFoundException - ballotId not found

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyUncastRacesForBallot

RaceList getMyUncastRacesForBallot(Id ballotId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all Races on this ballot for which a vote has not been cast.

Parameters:

ballotId - Id of the Ballot

Returns:

the uncast races

Throws:

NotFoundException - ballotId not found

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canVoteWithRecordTypes

boolean canVoteWithRecordTypes(Id raceId,
 Type[] voteRecordTypes)

Tests if this user can create a single Vote using the desired record interface types. While VotingManager.getVoteRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Vote . Providing an empty array tests if an Vote can be created with no records.

Parameters:

raceId - a race Id

voteRecordTypes - array of vote record types

Returns:

true if Vote creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - ballotId or voteRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getVotingAllocation

VoterAllocation getVotingAllocation(Id raceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the voter allocation for a race.

Parameters:

raceId - Id of the Race

Returns:

the allocation

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.

getVoteForm

VoteForm getVoteForm(Id raceId,
 Id candidateId,
 Type[] voteRecordTypes)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a vote form for a race.

Parameters:

raceId - Id of the Race

candidateId - a candidate

voteRecordTypes - array of vote record types

Returns:

the race

Throws:

NotFoundException - raceId or candidateId not found

NullArgumentException - raceId, candidateId , or voteRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - cannot get form with requested record types

Compliance:

mandatory - This method is must be implemented.

vote

Vote vote(VoteForm voteForm)
   throws OperationFailedException,
PermissionDeniedException

Votes for a candidate in a race.

Parameters:

voteForm - the vote form

Returns:

the vote

Throws:

IllegalStateException - voteForm already used in a voting transaction

InvalidArgumentException - form is invalid

NullArgumentException - voteForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - voteForm did not originate from getVoteForm()

Compliance:

mandatory - This method must be implemented.

getMyVotesForBallot

VoteList getMyVotesForBallot(Id ballotId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all my Votes cast on a ballot.

Parameters:

ballotId - a ballot

Returns:

the votes

Throws:

NotFoundException - ballotId is not found

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyVotesForRace

VoteList getMyVotesForRace(Id raceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all my Votes cast on this ballot for the given race.

Parameters:

raceId - a race

Returns:

the votes

Throws:

NotFoundException - raceId is not found

NullArgumentException - raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRevote

boolean canRevote(Id ballotId)
           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if this user can change a vote by deleting a vote and voting again.

Parameters:

ballotId - a ballot

Returns:

true if changing a vote is permitted, false otherwise

Throws:

NotFoundException - ballotId is not found

NullArgumentException - ballotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteMyVote

void deleteMyVote(Id voteId)
           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a vote in a race.

Parameters:

voteId - a vote

Throws:

IllegalStateException - canRevote() is false

NotFoundException - voteId is not found

NullArgumentException - voteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.