public interface SignalMapAssignmentSession extends OsidSession
This session provides methods to re-assign Signals
to
Map
objects A Signal
may appear in multiple
Map
objects and removing the last reference to a
Signal
is the equivalent of deleting it. Each Map
may have its own authorizations governing who is allowed to operate on it.
Adding a reference of a Signal
to another Map
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignSignalToMap(Id signalId,
Id mapId)
Adds an existing
Signal to a Map. |
boolean |
canAssignSignals()
Tests if this user can alter signal/map mappings.
|
boolean |
canAssignSignalsToMap(Id mapId)
Tests if this user can alter signal/map mappings.
|
IdList |
getAssignableMapIds(Id mapId)
Gets a list of maps including and under the given map node in which
any signal can be assigned.
|
IdList |
getAssignableMapIdsForSignal(Id mapId,
Id signalId)
Gets a list of maps including and under the given map node in which a
specific signal can be assigned.
|
void |
unassignSignalFromMap(Id signalId,
Id mapId)
Removes a
Signal from a Map. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignSignals()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if signal is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignSignalsToMap(Id mapId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.mapId
- the Id
of the Map
false
if mapping is not authorized, true
otherwiseNullArgumentException
- mapId
is
null
mandatory
- This method must be implemented. IdList getAssignableMapIds(Id mapId) throws OperationFailedException
mapId
- the Id
of the Map
Ids
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableMapIdsForSignal(Id mapId, Id signalId) throws OperationFailedException
mapId
- the Id
of the Map
signalId
- the Id
of the Signal
Ids
NullArgumentException
- mapId
or
signalId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignSignalToMap(Id signalId, Id mapId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Signal
to a Map.
signalId
- the Id
of the Signal
mapId
- the Id
of the Map
AlreadyExistsException
- signalId
is
already assigned to mapId
NotFoundException
- signalId
or
mapId
not foundNullArgumentException
- signalId
or
mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSignalFromMap(Id signalId, Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Signal
from a Map.
signalId
- the Id
of the Signal
mapId
- the Id
of the Map
NotFoundException
- signalId
or
mapId
not found or signalId
not
assigned to mapId
NullArgumentException
- signalId
or
mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.