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