public interface RaceProcessorPollsAssignmentSession extends OsidSession
This session provides methods to re-assign RaceProcessor
to Polls
mappings. a RaceProcessor
may
appear in multiple Polls
objects and removing the last
reference to a RaceProcessor
is the equivalent of deleting
it. Each Polls
may have its own authorizations governing
who is allowed to operate on it.
Adding a reference of a RaceProcessor
to another
Polls
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignRaceProcessorToPolls(Id raceProcessorId,
Id pollsId)
Adds an existing
RaceProcessor to a Polls. |
boolean |
canAssignRaceProcessors()
Tests if this user can alter race processor/polls mappings.
|
boolean |
canAssignRaceProcessorsToPolls(Id pollsId)
Tests if this user can alter race processor/polls mappings.
|
IdList |
getAssignablePollsIds(Id pollsId)
Gets a list of polls including and under the given polls node in which
any race processor can be assigned.
|
IdList |
getAssignablePollsIdsForRaceProcessor(Id pollsId,
Id raceProcessorId)
Gets a list of polls including and under the given polls node in which
a specific race processor can be assigned.
|
void |
reassignRaceProcessorToPolls(Id raceProcessorId,
Id fromPollsId,
Id toPollsId)
Moves a
RaceProcessor from one Polls to
another. |
void |
unassignRaceProcessorFromPolls(Id raceProcessorId,
Id pollsId)
Removes a
RaceProcessor from a Polls. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
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. boolean canAssignRaceProcessorsToPolls(Id pollsId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users.pollsId
- the Id
of the Polls
false
if mapping is not authorized, true
otherwiseNullArgumentException
- pollsId
is
null
mandatory
- This method must be implemented. IdList getAssignablePollsIds(Id pollsId) throws OperationFailedException
pollsId
- the Id
of the Polls
Ids
NullArgumentException
- pollsId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignablePollsIdsForRaceProcessor(Id pollsId, Id raceProcessorId) throws OperationFailedException
pollsId
- the Id
of the Polls
raceProcessorId
- the Id
of the
RaceProcessor
Ids
NullArgumentException
- pollsId
or
raceProcessorId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignRaceProcessorToPolls(Id raceProcessorId, Id pollsId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessor
to a Polls.
raceProcessorId
- the Id
of the
RaceProcessor
pollsId
- the Id
of the Polls
AlreadyExistsException
- raceProcessorId
is already assigned to pollsId
NotFoundException
- raceProcessorId
or
pollsId
not foundNullArgumentException
- raceProcessorId
or pollsId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRaceProcessorFromPolls(Id raceProcessorId, Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessor
from a Polls.
raceProcessorId
- the Id
of the
RaceProcessor
pollsId
- the Id
of the Polls
NotFoundException
- raceProcessorId
or
pollsId
not found or raceProcessorId
not assigned to pollsId
NullArgumentException
- raceProcessorId
or pollsId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignRaceProcessorToPolls(Id raceProcessorId, Id fromPollsId, Id toPollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessor
from one Polls
to
another. Mappings to other Polls
are unaffected.raceProcessorId
- the Id
of the
RaceProcessor
fromPollsId
- the Id
of the current Polls
toPollsId
- the Id
of the destination
Polls
NotFoundException
- raceProcessorId,
fromPollsId,
or toPollsId
not found or
raceProcessorId
not mapped to
fromPollsId
NullArgumentException
- raceProcessorId,
fromPollsId,
or toPollsId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.