public interface RaceProcessorRuleApplicationSession extends OsidSession
This session provides methods to apply RaceProcessors
to
Races.
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPollsId()
Polls
Id
associated with this
session. Polls Id
associated with this sessionmandatory
- This method must be implemented. Polls getPolls() throws OperationFailedException, PermissionDeniedException
Polls
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignRaceProcessors()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignRaceProcessorToRace(Id raceProcessorId, Id raceId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessor
to a Race.
raceProcessorId
- the Id
of the
RaceProcessor
raceId
- the Id
of the Race
AlreadyExistsException
- raceProcessorId
is already applied to raceId
NotFoundException
- raceProcessorId
or
raceId
not foundNullArgumentException
- raceProcessorId
or raceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRaceProcessorFromRace(Id raceProcessorId, Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessor
from a Race.
raceProcessorId
- the Id
of the
RaceProcessor
raceId
- the Id
of the Race
NotFoundException
- raceProcessorId
or
raceId
not found or raceProcessorId
not applied to raceId
NullArgumentException
- raceProcessorId
or raceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceRaceProcessors()
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. false
if RaceProcessor
ordering
is not authorized, true
otherwisemandatory
- This method must be implemented. void moveRaceProcessorAhead(Id raceProcessorId, Id raceId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceProcessorId
- the Id
of a
RaceProcessor
raceId
- the Id
of a Race
referenceId
- the reference race processor Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveRaceProcessorBehind(Id raceProcessorId, Id raceId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceProcessorId
- the Id
of a
RaceProcessor
raceId
- the Id
of a Race
referenceId
- the reference race processor Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderRaceProcessors(Id[] raceProcessorIds, Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceProcessorIds
- the Ids
for a set of
RaceProcessors
raceId
- the Id
of a Race
NotFoundException
- raceId
not found or,
a raceProcessorId
not related to
raceProcessorId
NullArgumentException
- raceProcessorIds
or raceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.