public interface BallotAuthoringSession extends OsidSession
This session provides methods for authoring ballots.
Modifier and Type | Method and 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 preceedingRaceId)
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBallotId()
Ballot
Id
associated with this
session. Ballot Id
associated with this sessionmandatory
- This method must be implemented. Ballot getBallot() throws OperationFailedException, PermissionDeniedException
Ballot
associated with this session. Ballot
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAuthorBallots()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. RaceList getRaces() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. void addRace(Id raceId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
raceId
- the Id
of the Race
AlreadyExistsException
- raceId
already
in ballotNotFoundException
- raceId
not foundNullArgumentException
- raceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void removeRace(Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Race
from this ballot.raceId
- the Id
of the Race
NotFoundException
- raceId
not in ballotNullArgumentException
- raceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void moveRace(Id raceId, Id preceedingRaceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceId
- the Id
of a Race
preceedingRaceId
- the Id
of a preceeding
Race
in the sequenceNotFoundException
- raceId
or
preceedingRaceId
is not foundNullArgumentException
- raceId
or
preceedingRaceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void orderRaces(Id[] raceIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceIds
- the Id
of the Races
NotFoundException
- a raceId
was not
foundNullArgumentException
- raceIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.