public interface RacePollsAssignmentSession extends OsidSession
This session provides methods to re-assign Races
to
Polls
objects A Race
may appear in multiple
Polls
objects and removing the last reference to a
Race
is the equivalent of deleting it. Each Polls
may have its own authorizations governing who is allowed to operate on it.
Moving or adding a reference of a Race
to another
Polls
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignRaceToPolls(Id raceId,
Id pollsId)
Adds an existing
Race to a Polls. |
boolean |
canAssignRaces()
Tests if this user can alter race/polls mappings.
|
boolean |
canAssignRacesToPolls(Id pollsId)
Tests if this user can alter race/polls mappings.
|
IdList |
getAssignablePollsIds(Id pollsId)
Gets a list of polls including and under the given polls node in which
any race can be assigned.
|
IdList |
getAssignablePollsIdsForRace(Id pollsId,
Id raceId)
Gets a list of polls including and under the given polls node in which
a specific race can be assigned.
|
void |
unassignRaceFromPolls(Id raceId,
Id pollsId)
Removes a
Race from a Polls. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignRaces()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignRacesToPolls(Id pollsId)
PERMISSION_DENIED
. This is intended as a hint to
an application that may opt not to offer assignment 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 getAssignablePollsIdsForRace(Id pollsId, Id raceId) throws OperationFailedException
pollsId
- the Id
of the Polls
raceId
- the Id
of the Race
Ids
NullArgumentException
- polls
or
raceId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignRaceToPolls(Id raceId, Id pollsId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Race
to a Polls.
raceId
- the Id
of the Race
pollsId
- the Id
of the Polls
AlreadyExistsException
- raceId
is
already assigned to pollsId
NotFoundException
- raceId
or
pollsId
not foundNullArgumentException
- raceId
or
pollsId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRaceFromPolls(Id raceId, Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Race
from a Polls.
raceId
- the Id
of the Race
pollsId
- the Id
of the Polls
NotFoundException
- raceId
or
pollsId
not found or raceId
not
assigned to pollsId
NullArgumentException
- raceId
or
pollsId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.