public interface SettingLookupSession extends OsidSession
This session defines methods for retrieving settings.
This lookup session defines several views:
Settings
with the SettingAdminSession.
The methods useFederatedSystemView()
and
useIsolatedSystemView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Settings may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the settings.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSettings()
Tests if this user can perform
Setting lookups. |
Setting |
getSetting(Id settingId)
Gets the
Setting specified by its Id. |
SettingList |
getSettings()
Gets all settings.
|
SettingList |
getSettingsByGenusType(Type settingGenusType)
Gets a
SettingList corresponding to the given setting
genus Type which does not include settings of types
derived from the specified Type. |
SettingList |
getSettingsByIds(IdList settingIds)
Gets a
SettingList corresponding to the given
IdList. |
SettingList |
getSettingsByParentGenusType(Type settingGenusType)
Gets a
SettingList corresponding to the given setting
genus Type and include any additional settings with
genus types derived from the specified Type. |
SettingList |
getSettingsByRecordType(Type settingRecordType)
Gets a
SettingList containing the given setting record
Type. |
SettingList |
getSettingsForController(Id controllerId)
Gets a list of settings for a controller.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useComparativeSettingView()
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 |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
void |
usePlenarySettingView()
A complete view of the
Setting returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupSettings()
Setting
lookups. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSettingView()
mandatory
- This method is must be implemented. void usePlenarySettingView()
Setting
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. void useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. Setting getSetting(Id settingId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Setting
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Setting
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Setting
and retained for compatibility.settingId
- the Id
of the Setting
to retrieve Setting
NotFoundException
- no Setting
found
with the given Id
NullArgumentException
- settingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SettingList getSettingsByIds(IdList settingIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
SettingList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
settings specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Settings
may be omitted from the list and
may present the elements in any order including returning a unique
set.settingIds
- the list of Ids
to retrieve Setting
listNotFoundException
- an Id
was not foundNullArgumentException
- settingIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SettingList getSettingsByGenusType(Type settingGenusType) throws OperationFailedException, PermissionDeniedException
SettingList
corresponding to the given setting
genus Type
which does not include settings of types
derived from the specified Type.
In plenary mode, the returned list contains all known
settings or an error results. Otherwise, the returned list may contain
only those settings that are accessible through this session.settingGenusType
- a setting genus type Setting
listNullArgumentException
- settingGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SettingList getSettingsByParentGenusType(Type settingGenusType) throws OperationFailedException, PermissionDeniedException
SettingList
corresponding to the given setting
genus Type
and include any additional settings with
genus types derived from the specified Type.
In plenary mode, the returned list contains all known
settings or an error results. Otherwise, the returned list may contain
only those settings that are accessible through this session.settingGenusType
- a setting genus type Setting
listNullArgumentException
- settingGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SettingList getSettingsByRecordType(Type settingRecordType) throws OperationFailedException, PermissionDeniedException
SettingList
containing the given setting record
Type.
In plenary mode, the returned list contains all known settings or an
error results. Otherwise, the returned list may contain only those
settings that are accessible through this session.settingRecordType
- a setting record type Setting
listNullArgumentException
- settingRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SettingList getSettingsForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
settings or an error results. Otherwise, the returned list may contain
only those settings that are accessible through this session.controllerId
- a controller Id
Setting
listNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SettingList getSettings() throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all of the
settings including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Settings
may be omitted from the list and
may present the elements in any order including returning a unique
set. Setting
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.