public interface ActionEnablerSystemAssignmentSession extends OsidSession
This session provides methods to re-assign ActionEnabler
to System
mappings. An ActionEnabler
may
appear in multiple System
objects and removing the last
reference to an ActionEnabler
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 ActionEnabler
to another
System
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignActionEnablerToSystem(Id actionEnablerId,
Id systemId)
Adds an existing
ActionEnabler to a System. |
boolean |
canAssignActionEnablers()
Tests if this user can alter action enabler/system mappings.
|
boolean |
canAssignActionEnablersToSystem(Id systemId)
Tests if this user can alter action enabler/system mappings.
|
IdList |
getAssignableSystemIds(Id systemId)
Gets a list of systems including and under the given system node in
which any action enabler can be assigned.
|
IdList |
getAssignableSystemIdsForActionEnabler(Id systemId,
Id actionEnablerId)
Gets a list of systems including and under the given system node in
which a specific action enabler can be assigned.
|
void |
reassignActionEnablerToSystem(Id actionEnablerId,
Id fromSystemId,
Id toSystemId)
Moves an
ActionEnabler from one System
to another. |
void |
unassignActionEnablerFromSystem(Id actionEnablerId,
Id systemId)
Removes an
ActionEnabler from a System. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignActionEnablers()
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 canAssignActionEnablersToSystem(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 System
Ids
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableSystemIdsForActionEnabler(Id systemId, Id actionEnablerId) throws OperationFailedException
systemId
- the Id
of the System
actionEnablerId
- the Id
of the
ActionEnabler
Ids
NullArgumentException
- systemId
or
actionEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignActionEnablerToSystem(Id actionEnablerId, Id systemId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ActionEnabler
to a System.
actionEnablerId
- the Id
of the
ActionEnabler
systemId
- the Id
of the System
AlreadyExistsException
- actionEnablerId
already assigned to systemId
NotFoundException
- actionEnablerId
or
systemId
not foundNullArgumentException
- actionEnablerId
or systemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignActionEnablerFromSystem(Id actionEnablerId, Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActionEnabler
from a System.
actionEnablerId
- the Id
of the
ActionEnabler
systemId
- the Id
of the System
NotFoundException
- actionEnablerId
or
systemId
not found or actionEnablerId
already assigned to systemId
NullArgumentException
- actionEnablerId
or systemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignActionEnablerToSystem(Id actionEnablerId, Id fromSystemId, Id toSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActionEnabler
from one System
to another. Mappings to other Systems
are unaffected.actionEnablerId
- the Id
of the
ActionEnabler
fromSystemId
- the Id
of the current
System
toSystemId
- the Id
of the destination
System
NotFoundException
- actionEnablerId,
fromSystemId,
or toSystemId
not found
or actionEnablerId
not mapped to
fromSystemId
NullArgumentException
- actionEnablerId,
fromSystemId,
or toSystemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.