public interface ParameterProcessorSmartConfigurationSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
configurations. A ParameterProcessorQuery
can be retrieved
from this session and mapped to this Configuration
to
create a virtual collection of parameter processors. The parameter
processor may be sequenced using the ParameterProcessorSearchOrder
from this session.
This Configuration
has a default query that matches any
parameter processor and a default search order that specifies no
sequencing. The queries may be examined using a
ParameterProcessorQueryInspector.
The query may be modified by
converting the inspector back to a ParameterProcessorQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyParameterProcessorQuery(ParameterProcessorQuery parameterProcessorQuery)
Applies a parameter processor query to this configuration.
|
void |
applyParameterProcessorSequencing(ParameterProcessorSearchOrder parameterProcessorSearchOrder)
Applies a parameter processor search order to this configuration.
|
boolean |
canManageSmartConfigurations()
Tests if this user can manage smart configurations.
|
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
ParameterProcessorQuery |
getParameterProcessorQuery()
Gets a parameter processor query.
|
ParameterProcessorQuery |
getParameterProcessorQueryFromInspector(ParameterProcessorQueryInspector parameterProcessorQueryInspector)
Gets a parameter processor query from an inspector.
|
ParameterProcessorSearchOrder |
getParameterProcessorSearchOrder()
Gets a parameter processor search order.
|
ParameterProcessorQueryInspector |
inspectParameterProcessorQuery()
Gets a parameter processor query inspector for this configuration.
|
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 canManageSmartConfigurations()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart configuration management is not
authorized, true
otherwisemandatory
- This method must be implemented. ParameterProcessorQuery getParameterProcessorQuery()
mandatory
- This method must be implemented. ParameterProcessorSearchOrder getParameterProcessorSearchOrder()
mandatory
- This method must be implemented. void applyParameterProcessorQuery(ParameterProcessorQuery parameterProcessorQuery) throws OperationFailedException, PermissionDeniedException
parameterProcessorQuery
- the parameter processor queryNullArgumentException
- parameterProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- parameterProcessorQuery
not of this servicemandatory
- This method must be implemented. ParameterProcessorQueryInspector inspectParameterProcessorQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyParameterProcessorSequencing(ParameterProcessorSearchOrder parameterProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
parameterProcessorSearchOrder
- the parameter processor search
orderNullArgumentException
-
parameterProcessorSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
parameterProcessorSearchOrder
not of this servicemandatory
- This method must be implemented. ParameterProcessorQuery getParameterProcessorQueryFromInspector(ParameterProcessorQueryInspector parameterProcessorQueryInspector)
parameterProcessorQueryInspector
- a parameter processor query
inspectorNullArgumentException
-
parameterProcessorQueryInspector
is null
UnsupportedException
-
parameterProcessorQueryInspector
is not of this
servicemandatory
- This method must be implemented.