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