public interface ParameterQuerySession extends OsidSession
This session provides methods for searching Parameter
objects. The search query is constructed using the ParameterQuery.
Two views of the configuration data are defined;
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchParameters()
Tests if this user can perform
Parameter searches. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
ParameterQuery |
getParameterQuery()
Gets a paraameter query.
|
ParameterList |
getParametersByQuery(ParameterQuery parameterQuery)
Gets a list of
Parameters matching the given query. |
void |
useFederatedConfigurationView()
Federates the view for methods in this session.
|
void |
useIsolatedConfigurationView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getConfigurationId()
Configuration
Id
associated
with this session. Configuration
Id
associated
with this sessionmandatory
- This method must be implemented. Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
Configuration
associated with this session. Configuration
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchParameters()
Parameter
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 lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedConfigurationView()
mandatory
- This method is must be implemented. void useIsolatedConfigurationView()
mandatory
- This method is must be implemented. ParameterQuery getParameterQuery()
mandatory
- This method must be implemented. ParameterList getParametersByQuery(ParameterQuery parameterQuery) throws OperationFailedException, PermissionDeniedException
Parameters
matching the given query.parameterQuery
- the parameter query ParameterList
NullArgumentException
- parameterQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- a query form is not of this
servicemandatory
- This method must be implemented.