public interface ParameterProcessorEnablerQuerySession extends OsidSession
This session provides methods for searching among
ParameterProcessorEnabler
objects. The search query is constructed
using the ParameterProcessorEnablerQuery.
This session defines views that offer differing behaviors for searching.
Parameter processor enablers may have a query record indicated by
their respective record types. The query record is accessed via the
ParameterProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchParameterProcessorEnablers()
Tests if this user can perform
ParameterProcessorEnabler
lookups. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
ParameterProcessorEnablerQuery |
getParameterProcessorEnablerQuery()
Gets a parameter processor enabler query.
|
ParameterProcessorEnablerList |
getParameterProcessorEnablersByQuery(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery)
Gets a list of
ParameterProcessorEnablers matching the
given parameter processor 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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchParameterProcessorEnablers()
ParameterProcessorEnabler
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 useFederatedConfigurationView()
mandatory
- This method is must be implemented. void useIsolatedConfigurationView()
mandatory
- This method is must be implemented. ParameterProcessorEnablerQuery getParameterProcessorEnablerQuery()
mandatory
- This method must be implemented. ParameterProcessorEnablerList getParameterProcessorEnablersByQuery(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablers
matching the
given parameter processor query.parameterProcessorEnablerQuery
- the parameter processor enabler
query ParameterProcessorEnablerList
NullArgumentException
-
parameterProcessorEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
parameterProcessorEnablerQuery
is not of this servicemandatory
- This method must be implemented.