org.osid.voting.rules

Interface RaceProcessorRuleApplicationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface RaceProcessorRuleApplicationSession
extends OsidSession

This session provides methods to apply RaceProcessors to Races.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignRaceProcessorToRace(Id raceProcessorId, Id raceId) Adds an existing RaceProcessor to a Race.
boolean	canAssignRaceProcessors() Tests if this user can alter race processor/race mappings.
boolean	canSequenceRaceProcessors() Tests if this user can order RaceProcessors.
Polls	getPolls() Gets the Polls associated with this session.
Id	getPollsId() Gets the Polls Id associated with this session.
void	moveRaceProcessorAhead(Id raceProcessorId, Id raceId, Id referenceId) Reorders race processors for a race by moving the specified race processor in front of a reference race processor.
void	moveRaceProcessorBehind(Id raceProcessorId, Id raceId, Id referenceId) Reorders race processors for a race by moving the specified race processor behind a reference race processor.
void	orderRaceProcessors(Id[] raceProcessorIds, Id raceId) Reorders a set of race processors for a race.
void	unassignRaceProcessorFromRace(Id raceProcessorId, Id raceId) Removes a RaceProcessor from a Race.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canAssignRaceProcessors

boolean canAssignRaceProcessors()

Tests if this user can alter race processor/race mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignRaceProcessorToRace

void assignRaceProcessorToRace(Id raceProcessorId,
                             Id raceId)
                               throws AlreadyExistsException,
                                      NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Adds an existing RaceProcessor to a Race.

Parameters:

raceProcessorId - the Id of the RaceProcessor

raceId - the Id of the Race

Throws:

AlreadyExistsException - raceProcessorId is already applied to raceId

NotFoundException - raceProcessorId or raceId not found

NullArgumentException - raceProcessorId or raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignRaceProcessorFromRace

void unassignRaceProcessorFromRace(Id raceProcessorId,
                                 Id raceId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Removes a RaceProcessor from a Race.

Parameters:

raceProcessorId - the Id of the RaceProcessor

raceId - the Id of the Race

Throws:

NotFoundException - raceProcessorId or raceId not found or raceProcessorId not applied to raceId

NullArgumentException - raceProcessorId or raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceRaceProcessors

boolean canSequenceRaceProcessors()

Tests if this user can order RaceProcessors. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if RaceProcessor ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveRaceProcessorAhead

void moveRaceProcessorAhead(Id raceProcessorId,
                          Id raceId,
                          Id referenceId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Reorders race processors for a race by moving the specified race processor in front of a reference race processor.

Parameters:

raceProcessorId - the Id of a RaceProcessor

raceId - the Id of a Race

referenceId - the reference race processor Id

Throws:

NotFoundException - raceProcessorId, raceId, or referenceId not found or, raceProcessorId or referenceId not related to raceId

NullArgumentException - raceProcessorId, raceId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveRaceProcessorBehind

void moveRaceProcessorBehind(Id raceProcessorId,
                           Id raceId,
                           Id referenceId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Reorders race processors for a race by moving the specified race processor behind a reference race processor.

Parameters:

raceProcessorId - the Id of a RaceProcessor

raceId - the Id of a Race

referenceId - the reference race processor Id

Throws:

NotFoundException - raceProcessorId, raceId, or referenceId not found or, raceProcessorId or referenceId not related to raceId

NullArgumentException - raceProcessorId, raceId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderRaceProcessors

void orderRaceProcessors(Id[] raceProcessorIds,
                       Id raceId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Reorders a set of race processors for a race.

Parameters:

raceProcessorIds - the Ids for a set of RaceProcessors

raceId - the Id of a Race

Throws:

NotFoundException - raceId not found or, a raceProcessorId not related to raceProcessorId

NullArgumentException - raceProcessorIds or raceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.