public interface RaceProcessorEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply RaceProcessorEnablers
to RaceProcessors.
a RaceProcessor
with multiple RaceProcessorEnablers
means any positive rule
evaluation across the enablers result in an effective
RaceProcessor.
Modifier and Type | Method and Description |
---|---|
void |
assignRaceProcessorEnablerToRaceProcessor(Id raceProcessorEnablerId,
Id raceProcessorId)
Adds an existing
RaceProcessorEnabler to a
RaceProcessor. |
boolean |
canAssignRaceProcessorEnablers()
Tests if this user can alter race processor enabler/race processor
mappings.
|
boolean |
canSequenceRaceProcessorEnablers()
Tests if this user can order
RaceProcessorEnablers. |
Polls |
getPolls()
Gets the
Polls associated with this session. |
Id |
getPollsId()
Gets the
Polls Id associated with this
session. |
void |
moveRaceProcessorEnablerAhead(Id raceProcessorEnablerId,
Id raceProcessorId,
Id referenceId)
Reorders race processor enablers for a race processor by moving the
specified race processor enabler in front of a reference race
processor enabler.
|
void |
moveRaceProcessorEnablerBehind(Id raceProcessorEnablerId,
Id raceProcessorId,
Id referenceId)
Reorders race processor enablers for a race processor by moving the
specified race processor enabler behind a reference race processor
enabler.
|
void |
orderRaceProcessorEnablers(Id[] raceProcessorEnablerIds,
Id raceProcessorId)
Reorders a set of race processor enablers for a race processor.
|
void |
unassignRaceProcessorEnablerFromRaceProcessor(Id raceProcessorEnablerId,
Id raceProcessorId)
Removes a
RaceProcessorEnabler from a
RaceProcessor. |
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 canAssignRaceProcessorEnablers()
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 assignRaceProcessorEnablerToRaceProcessor(Id raceProcessorEnablerId, Id raceProcessorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessorEnabler
to a
RaceProcessor.
raceProcessorEnablerId
- the Id
of the
RaceProcessorEnabler
raceProcessorId
- the Id
of the
RaceProcessor
AlreadyExistsException
- raceProcessorEnablerId
is already applied to raceProcessorId
NotFoundException
- raceProcessorEnablerId
or raceProcessorId
not foundNullArgumentException
- raceProcessorEnablerId
or raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRaceProcessorEnablerFromRaceProcessor(Id raceProcessorEnablerId, Id raceProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessorEnabler
from a
RaceProcessor.
raceProcessorEnablerId
- the Id
of the
RaceProcessorEnabler
raceProcessorId
- the Id
of the
RaceProcessor
NotFoundException
- raceProcessorEnablerId
or raceProcessorId
not found or
raceProcessorEnablerId
not applied to
raceProcessorId
NullArgumentException
- raceProcessorEnablerId
or raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceRaceProcessorEnablers()
RaceProcessorEnablers.
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 RaceProcessorEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveRaceProcessorEnablerAhead(Id raceProcessorEnablerId, Id raceProcessorId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceProcessorEnablerId
- the Id
of a
RaceProcessorEnabler
raceProcessorId
- the Id
of a
RaceProcessor
referenceId
- the reference race processor enabler Id
NotFoundException
- raceProcessorEnablerId,
raceProcessorId,
or referenceId
not
found or, raceProcessorEnablerId
or
referenceId
not related to processorId
NullArgumentException
- raceProcessorEnablerId,
raceProcessorId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveRaceProcessorEnablerBehind(Id raceProcessorEnablerId, Id raceProcessorId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceProcessorEnablerId
- the Id
of a
RaceProcessorEnabler
raceProcessorId
- the Id
of a
RaceProcessor
referenceId
- the reference race processor enabler Id
NotFoundException
- praceProcessorEnablerId,
raceProcessorId,
or referenceId
not
found or, raceProcessorEnablerId
or
referenceId
not related to processorId
NullArgumentException
- raceProcessorEnablerId,
raceProcessorId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderRaceProcessorEnablers(Id[] raceProcessorEnablerIds, Id raceProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
raceProcessorEnablerIds
- the Ids
for a set of
RaceProcessorEnablers
raceProcessorId
- the Id
of a
RaceProcessor
NotFoundException
- raceProcessorId
not
found or, a raceProcessorEnablerId
not related
to raceProcessorId
NullArgumentException
- raceProcessorEnablerIds
or raceProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.