public interface RaceProcessorEnablerPollsAssignmentSession extends OsidSession
This session provides methods to re-assign RaceProcessorEnabler
to Polls
mappings. a RaceProcessorEnabler
may appear in multiple Polls
objects and removing
the last reference to a RaceProcessorEnabler
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 RaceProcessorEnabler
to another
Polls
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignRaceProcessorEnablerToPolls(Id raceProcessorEnablerId,
Id pollsId)
Adds an existing
RaceProcessorEnabler to a
Polls. |
boolean |
canAssignRaceProcessorEnablers()
Tests if this user can alter race processor enabler/polls mappings.
|
boolean |
canAssignRaceProcessorEnablersToPolls(Id pollsId)
Tests if this user can alter race processor enabler/polls mappings.
|
IdList |
getAssignablePollsIds(Id pollsId)
Gets a list of polls including and under the given polls node in which
any race processor enabler can be assigned.
|
IdList |
getAssignablePollsIdsForRaceProcessorEnabler(Id pollsId,
Id raceProcessorEnablerId)
Gets a list of polls including and under the given polls node in which
a specific race processor enabler can be assigned.
|
void |
reassignRaceProcessorEnablerToPolls(Id raceProcessorEnablerId,
Id fromPollsId,
Id toPollsId)
Moves a
RaceProcessorEnabler from one Polls
to another. |
void |
unassignRaceProcessorEnablerFromPolls(Id raceProcessorEnablerId,
Id pollsId)
Removes a
RaceProcessorEnabler from a Polls. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
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. boolean canAssignRaceProcessorEnablersToPolls(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 getAssignablePollsIdsForRaceProcessorEnabler(Id pollsId, Id raceProcessorEnablerId) throws OperationFailedException
pollsId
- the Id
of the Polls
raceProcessorEnablerId
- the Id
of the
RaceProcessorEnabler
Ids
NullArgumentException
- pollsId
or
raceProcessorEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignRaceProcessorEnablerToPolls(Id raceProcessorEnablerId, Id pollsId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessorEnabler
to a
Polls.
raceProcessorEnablerId
- the Id
of the
RaceProcessorEnabler
pollsId
- the Id
of the Polls
AlreadyExistsException
- raceProcessorEnablerId
is already assigned to pollsId
NotFoundException
- raceProcessorEnablerId
or pollsId
not foundNullArgumentException
- raceProcessorEnablerId
or pollsId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRaceProcessorEnablerFromPolls(Id raceProcessorEnablerId, Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessorEnabler
from a Polls.
raceProcessorEnablerId
- the Id
of the
RaceProcessorEnabler
pollsId
- the Id
of the Polls
NotFoundException
- raceProcessorEnablerId
or pollsId
not found or
raceProcessorEnablerId
not assigned to pollsId
NullArgumentException
- raceProcessorEnablerId
or pollsId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignRaceProcessorEnablerToPolls(Id raceProcessorEnablerId, Id fromPollsId, Id toPollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RaceProcessorEnabler
from one Polls
to another. Mappings to other Polls
are
unaffected.raceProcessorEnablerId
- the Id
of the
RaceProcessorEnabler
fromPollsId
- the Id
of the current Polls
toPollsId
- the Id
of the destination
Polls
NotFoundException
- raceProcessorEnablerId,
fromPollsId,
or toPollsId
not found or
raceProcessorEnablerId
not mapped to
fromPollsId
NullArgumentException
- raceProcessorEnablerId,
fromPollsId,
or toPollsId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.