public interface SignalEnablerMapAssignmentSession extends OsidSession
This session provides methods to re-assign SignalEnabler
to Map
mappings. A SignalEnabler
may appear
in multiple Map
objects and removing the last reference to
a SignalEnabler
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 SignalEnabler
to another
Map
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignSignalEnablerToMap(Id signalEnablerId,
Id mapId)
Adds an existing
SignalEnabler to an Map. |
boolean |
canAssignSignalEnablers()
Tests if this user can alter signal enabler/map mappings.
|
boolean |
canAssignSignalEnablersToMap(Id mapId)
Tests if this user can alter signal enabler/map mappings.
|
IdList |
getAssignableMapIds(Id mapId)
Gets a list of maps including and under the given map node in which
any signal enabler can be assigned.
|
IdList |
getAssignableMapIdsForSignalEnabler(Id mapId,
Id signalEnablerId)
Gets a list of maps including and under the given map node in which a
specific signal enabler can be assigned.
|
void |
unassignSignalEnablerFromMap(Id signalEnablerId,
Id mapId)
Removes a
SignalEnabler from an Map. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignSignalEnablers()
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 canAssignSignalEnablersToMap(Id mapId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup 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 getAssignableMapIdsForSignalEnabler(Id mapId, Id signalEnablerId) throws OperationFailedException
mapId
- the Id
of the Map
signalEnablerId
- the Id
of the
SignalEnabler
Ids
NullArgumentException
- mapId
or
signalEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignSignalEnablerToMap(Id signalEnablerId, Id mapId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
SignalEnabler
to an Map.
signalEnablerId
- the Id
of the
SignalEnabler
mapId
- the Id
of the Map
AlreadyExistsException
- signalEnablerId
is already assigned to mapId
NotFoundException
- signalEnablerId
or
mapId
not foundNullArgumentException
- signalEnablerId
or mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSignalEnablerFromMap(Id signalEnablerId, Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SignalEnabler
from an Map.
signalEnablerId
- the Id
of the
SignalEnabler
mapId
- the Id
of the Map
NotFoundException
- signalEnablerId
or
mapId
not found or signalEnablerId
not assigned to mapId
NullArgumentException
- signalEnablerId
or mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.