Interface BallotAuthoringSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BallotAuthoringSession
extends OsidSession

This session provides methods for authoring ballots.

Method Summary

Modifier and Type	Method	Description
void	addRace(Id raceId)	Adds a race to this ballot.
boolean	canAuthorBallots()	Tests if this user can perform author ballots.
Ballot	getBallot()	Gets the Ballot associated with this session.
Id	getBallotId()	Gets the Ballot Id associated with this session.
RaceList	getRaces()	Gets the races on this ballot.
void	moveRace(Id raceId, Id precedingRaceId)	Moves an existing race to follow another race in this ballot.
void	orderRaces(Id[] raceIds)	Sequences existing races on this ballot.
void	removeRace(Id raceId)	Removes a Race from this ballot.

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

getBallotId

Id getBallotId()

Gets the Ballot Id associated with this session.

Returns:

the Ballot Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBallot

Ballot getBallot()
          throws OperationFailedException,
PermissionDeniedException

Gets the Ballot associated with this session.

Returns:

the Ballot associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAuthorBallots

boolean canAuthorBallots()

Tests if this user can perform author ballots. 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 lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getRaces

RaceList getRaces()
           throws OperationFailedException,
PermissionDeniedException

Gets the races on this ballot.

Returns:

the races

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

addRace

void addRace(Id raceId)
      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a race to this ballot.

Parameters:

raceId - the Id of the Race

Throws:

AlreadyExistsException - raceId already in ballot

NotFoundException - raceId not found

NullArgumentException - raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

removeRace

void removeRace(Id raceId)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a Race from this ballot.

Parameters:

raceId - the Id of the Race

Throws:

NotFoundException - raceId not in ballot

NullArgumentException - raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

moveRace

void moveRace(Id raceId,
 Id precedingRaceId)
       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an existing race to follow another race in this ballot.

Parameters:

raceId - the Id of a Race

precedingRaceId - the Id of a preceding Race in the sequence

Throws:

NotFoundException - raceId or precedingRaceId is not found

NullArgumentException - raceId or precedingRaceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

orderRaces

void orderRaces(Id[] raceIds)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Sequences existing races on this ballot.

Parameters:

raceIds - the Id of the Races

Throws:

NotFoundException - a raceId was not found

NullArgumentException - raceIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.