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