public interface InputEnablerSystemAssignmentSession extends OsidSession
This session provides methods to re-assign InputEnabler
to System
mappings. An InputEnabler
may
appear in multiple System
objects and removing the last
reference to an InputEnabler
is the equivalent of deleting
it. Each System
may have its own authorizations governing
who is allowed to operate on it.
Adding a reference of an InputEnabler
to another
System
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignInputEnablerToSystem(Id inputEnablerId,
Id systemId)
Adds an existing
InputEnabler to a System. |
boolean |
canAssignInputEnablers()
Tests if this user can alter input enabler/system mappings.
|
boolean |
canAssignInputEnablersToSystem(Id systemId)
Tests if this user can alter input enabler/system mappings.
|
IdList |
getAssignableSystemIds(Id systemId)
Gets a list of systems including and under the given system node in
which any input enabler can be assigned.
|
IdList |
getAssignableSystemIdsForInputEnabler(Id systemId,
Id inputEnablerId)
Gets a list of systems including and under the given system node in
which a specific input enabler can be assigned.
|
void |
reassignInputEnablerToSystem(Id inputEnablerId,
Id fromSystemId,
Id toSystemId)
Moves an
InputEnabler from one System to
another. |
void |
unassignInputEnablerFromSystem(Id inputEnablerId,
Id systemId)
Removes an
InputEnabler from a System. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignInputEnablers()
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 canAssignInputEnablersToSystem(Id systemId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users.systemId
- the Id
of the System
false
if mapping is not authorized, true
otherwiseNullArgumentException
- systemId
is
null
mandatory
- This method must be implemented. IdList getAssignableSystemIds(Id systemId) throws OperationFailedException
systemId
- the Id
of the Syestem
Ids
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableSystemIdsForInputEnabler(Id systemId, Id inputEnablerId) throws OperationFailedException
systemId
- the Id
of the System
inputEnablerId
- the Id
of the
InputEnabler
Ids
NullArgumentException
- systemId
or
inputEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignInputEnablerToSystem(Id inputEnablerId, Id systemId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
InputEnabler
to a System.
inputEnablerId
- the Id
of the
InputEnabler
systemId
- the Id
of the System
AlreadyExistsException
- inputEnablerId
already assigned to systemId
NotFoundException
- inputEnablerId
or
systemId
not foundNullArgumentException
- inputEnablerId
or systemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignInputEnablerFromSystem(Id inputEnablerId, Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InputEnabler
from a System.
inputEnablerId
- the Id
of the
InputEnabler
systemId
- the Id
of the System
NotFoundException
- inputEnablerId
or
systemId
not found or inputEnablerId
not assigned to systemId
NullArgumentException
- inputEnablerId
or systemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignInputEnablerToSystem(Id inputEnablerId, Id fromSystemId, Id toSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InputEnabler
from one System
to
another. Mappings to other Systems
are unaffected.inputEnablerId
- the Id
of the
InputEnabler
fromSystemId
- the Id
of the current
System
toSystemId
- the Id
of the destination
System
NotFoundException
- inputEnablerId,
fromSystemId,
or toSystemId
not found
or inputEnablerId
not mapped to
fromSystemId
NullArgumentException
- inputEnablerId,
fromSystemId,
or toSystemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.