public interface RaceConstrainerRuleApplicationSession extends OsidSession
This session provides methods to apply RaceConstrainers
to Races.
A Race
with multiple
RaceConstrainers
means any positive rule evaluation across the
constrainers result in an accessible Race.
Modifier and Type | Method and Description |
---|---|
void |
assignRaceConstrainerToRace(Id raceConstrainerId,
Id raceId)
Adds an existing
RaceConstrainer to a Race. |
boolean |
canAssignRaceConstrainers()
Tests if this user can alter race constrainer/race mappings.
|
boolean |
canSequenceRaceConstrainers()
Tests if this user can order
RaceConstrainers. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
void |
moveRaceConstrainerAhead(Id raceConstrainerId,
Id raceId,
Id referenceId)
Reorders race constrainers for a race by moving the specified race
constrainer in front of a reference race constrainer.
|
void |
moveRaceConstrainerBehind(Id raceConstrainerId,
Id raceId,
Id referenceId)
Reorders race constrainers for a race by moving the specified race
constrainer behind a reference race constrainer.
|
void |
orderRaceConstrainers(Id[] raceConstrainerIds,
Id raceId)
Reorders a set of race constrainers for a race.
|
void |
unassignRaceConstrainerFromRace(Id raceConstrainerId,
Id raceId)
Removes a
RaceConstrainer 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 canAssignRaceConstrainers()
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 assignRaceConstrainerToRace(Id raceConstrainerId, Id raceId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainer
to a Race.
raceConstrainerId
- the Id
of the
RaceConstrainer
raceId
- the Id
of the Race
AlreadyExistsException
- raceConstrainerId
is already applied to raceId
NotFoundException
- raceConstrainerId
or
raceId
not foundNullArgumentException
- raceConstrainerId
or raceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRaceConstrainerFromRace(Id raceConstrainerId, Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceConstrainer
from a Race.
raceConstrainerId
- the Id
of the
RaceConstrainer
raceId
- the Id
of the Race
NotFoundException
- raceConstrainerId
or
raceId
not found or raceConstrainerId
not applied to raceId
NullArgumentException
- raceConstrainerId
or raceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceRaceConstrainers()
RaceConstrainers.
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 RaceConstrainer
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveRaceConstrainerAhead(Id raceConstrainerId, Id raceId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceConstrainerId
- the Id
of a
RaceConstrainer
raceId
- the Id
of a Race
referenceId
- the reference race constrainer Id
NotFoundException
- raceConstrainerId, raceId,
or referenceId
not found or,
raceConstrainerId
or referenceId
not
related to raceId
NullArgumentException
- raceConstrainerId,
raceId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveRaceConstrainerBehind(Id raceConstrainerId, Id raceId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceConstrainerId
- the Id
of a
RaceConstrainer
raceId
- the Id
of a Race
referenceId
- the reference race constrainer Id
NotFoundException
- raceConstrainerId, raceId,
or referenceId
not found or,
raceConstrainerId
or referenceId
not
related to raceId
NullArgumentException
- raceConstrainerId,
raceId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderRaceConstrainers(Id[] raceConstrainerIds, Id raceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceConstrainerIds
- the Ids
for a set of
RaceConstrainers
raceId
- the Id
of a Race
NotFoundException
- raceId
not found or,
a raceConstrainerId
not related to
raceId
NullArgumentException
- raceConstrainerIds
or raceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.