public interface ConfigurationQuerySession extends OsidSession
This session provides methods for searching among Configuration
objects. The search query is constructed using the
ConfigurationQuery.
Configurations may have a query record indicated by their respective
record types. The query record is accessed via the
ConfigurationQuery.
The returns in this session may not be cast
directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchConfigurations()
Tests if this user can perform
Configuration searches. |
ConfigurationQuery |
getConfigurationQuery()
Gets a configuration query.
|
ConfigurationList |
getConfigurationsByQuery(ConfigurationQuery configurationQuery)
Gets a list of
Configurations matching the given
search. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchConfigurations()
Configuration
searches.
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 opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. ConfigurationQuery getConfigurationQuery()
mandatory
- This method must be implemented. ConfigurationList getConfigurationsByQuery(ConfigurationQuery configurationQuery) throws OperationFailedException, PermissionDeniedException
Configurations
matching the given
search.configurationQuery
- the configuration query ConfigurationList
NullArgumentException
- configurationQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- configurationQuery
is not of this servicemandatory
- This method must be implemented.