public interface ParameterProcessorEnablerSmartConfigurationSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
configurations. A ParameterProcessorEnablerQuery
can be
retrieved from this session and mapped to this Configuration
to create a virtual collection of parameter processor enablers.
The parameter processor enablers may be sequenced using the
ParameterProcessorEnablerSearchOrder
from this session.
This Configuration
has a default query that matches any
parameter processor enabler and a default search order that specifies no
sequencing. The queries may be examined using a
ParameterProcessorEnablerQueryInspector.
The query may be modified
by converting the inspector back to a
ParameterProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyParameterProcessorEnablerQuery(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery)
Applies a parameter processor enabler query to this configuration.
|
void |
applyParameterProcessorEnablerSequencing(ParameterProcessorEnablerSearchOrder parameterProcessorEnablerSearchOrder)
Applies a parameter processor enabler 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. |
ParameterProcessorEnablerQuery |
getParameterProcessorEnablerQuery()
Gets a parameter processor enabler query.
|
ParameterProcessorEnablerQuery |
getParameterProcessorEnablerQueryFromInspector(ParameterProcessorEnablerQueryInspector parameterProcessorEnablerQueryInspector)
Gets a parameter processor enabler query from an inspector.
|
ParameterProcessorEnablerSearchOrder |
getParameterProcessorEnablerSearchOrder()
Gets a parameter processor enabler search order.
|
ParameterProcessorEnablerQueryInspector |
inspectParameterProcessorEnablerQuery()
Gets a parameter processor enabler 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. ParameterProcessorEnablerQuery getParameterProcessorEnablerQuery()
mandatory
- This method must be implemented. ParameterProcessorEnablerSearchOrder getParameterProcessorEnablerSearchOrder()
mandatory
- This method must be implemented. void applyParameterProcessorEnablerQuery(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
parameterProcessorEnablerQuery
- the parameter processor enabler
queryNullArgumentException
-
parameterProcessorEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
parameterProcessorEnablerQuery
not of this servicemandatory
- This method must be implemented. ParameterProcessorEnablerQueryInspector inspectParameterProcessorEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyParameterProcessorEnablerSequencing(ParameterProcessorEnablerSearchOrder parameterProcessorEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
parameterProcessorEnablerSearchOrder
- the parameter processor
enabler search orderNullArgumentException
-
parameterProcessorEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
parameterProcessorEnablerSearchOrder
not of this
servicemandatory
- This method must be implemented. ParameterProcessorEnablerQuery getParameterProcessorEnablerQueryFromInspector(ParameterProcessorEnablerQueryInspector parameterProcessorEnablerQueryInspector)
parameterProcessorEnablerQueryInspector
- a parameter processor
enabler query inspectorNullArgumentException
-
parameterProcessorEnablerQueryInspector
is null
UnsupportedException
-
parameterProcessorEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.