public interface SettingSystemSession extends OsidSession
This session provides methods to retrieve Setting
to
System
settings. A Setting
may appear in
multiple System
objects. Each system may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSettingSystemSettings()
Tests if this user can perform lookups of setting/system mappings.
|
IdList |
getSettingIdsBySystem(Id systemId)
Gets the list of
Setting Ids associated with a
System. |
IdList |
getSettingIdsBySystems(IdList systemIds)
Gets the list of
Setting Ids corresponding to a list of
Systems. |
SettingList |
getSettingsBySystem(Id systemId)
Gets the list of
Settings associated with a
System. |
SettingList |
getSettingsBySystems(IdList systemIds)
Gets the list of
Settings corresponding to a list of
Systems. |
IdList |
getSystemIdsBySetting(Id settingId)
Gets the
System Ids mapped to a
Setting. |
SystemList |
getSystemsBySetting(Id settingId)
Gets the
Systems mapped to a Setting. |
void |
useComparativeSettingSystemView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenarySettingSystemView()
A complete view of the
Setting and System
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSettingSystemSettings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up settings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSettingSystemView()
mandatory
- This method is must be implemented. void usePlenarySettingSystemView()
Setting
and System
returns is desired. Methods will return what is requested or
result in an error. This view is used when greater precision is
desired at the expense of interoperability.mandatory
- This method is must be implemented. IdList getSettingIdsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Setting Ids
associated with a
System.
systemId
- Id
of the System
Ids
NotFoundException
- systemId
is not
foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SettingList getSettingsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Settings
associated with a
System.
systemId
- Id
of the System
NotFoundException
- systemId
is not
foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSettingIdsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Setting Ids
corresponding to a list of
Systems.
systemIds
- list of system Ids
Ids
NullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SettingList getSettingsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Settings
corresponding to a list of
Systems.
systemIds
- list of system Ids
NullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSystemIdsBySetting(Id settingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
Ids
mapped to a
Setting.
settingId
- Id
of a Setting
NotFoundException
- settingId
is not
foundNullArgumentException
- settingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsBySetting(Id settingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Systems
mapped to a Setting.
settingId
- Id
of a Setting
NotFoundException
- settingId
is not
foundNullArgumentException
- settingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.