public interface SettingQuerySession extends OsidSession
This session provides methods for searching among Setting
objects. The search query is constructed using the
SettingQuery.
This session defines views that offer differing behaviors for searching.
settings may have a query record indicated by their respective record
types. The query record is accessed via the SettingQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchSettings()
Tests if this user can perform
Setting lookups. |
SettingQuery |
getSettingQuery()
Gets a setting query.
|
SettingList |
getSettingsByQuery(SettingQuery settingQuery)
Gets a list of
Settings matching the given setting
query. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
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 canSearchSettings()
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 search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. SettingQuery getSettingQuery()
mandatory
- This method must be implemented. SettingList getSettingsByQuery(SettingQuery settingQuery) throws OperationFailedException, PermissionDeniedException
Settings
matching the given setting
query.settingQuery
- the setting query SettingList
NullArgumentException
- settingQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- settingQuery
is
not of this servicemandatory
- This method must be implemented.