Interface | osid.configuration.rules.ParameterProcessorEnablerSmartConfigurationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic configurations. A This | ||
Method | getConfigurationId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Configuration Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getConfiguration | ||
Description |
Gets the | ||
Return | osid.configuration.Configuration | the configuration | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartConfigurations | ||
Description |
Tests if this user can manage smart configurations. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known methods in this session will result in a | ||
Return | boolean | false if smart configuration management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorEnablerQuery | ||
Description |
Gets a parameter processor enabler query. | ||
Return | osid.configuration.rules.ParameterProcessorEnablerQuery | the parameter processor enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorEnablerSearchOrder | ||
Description |
Gets a parameter processor enabler search order. | ||
Return | osid.configuration.rules.ParameterProcessorEnablerSearchOrder | the parameter processor enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyParameterProcessorEnablerQuery | ||
Description |
Applies a parameter processor enabler query to this configuration. | ||
Parameters | osid.configuration.rules.ParameterProcessorEnablerQuery | parameterProcessorEnablerQuery | the parameter processor enabler query |
Errors | NULL_ARGUMENT | parameterProcessorEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | parameterProcessorEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectParameterProcessorEnablerQuery | ||
Description |
Gets a parameter processor enabler query inspector for this configuration. | ||
Return | osid.configuration.rules.ParameterProcessorEnablerQueryInspector | the parameter processor enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyParameterProcessorEnablerSequencing | ||
Description |
Applies a parameter processor enabler search order to this configuration. | ||
Parameters | osid.configuration.rules.ParameterProcessorEnablerSearchOrder | parameterProcessorEnablerSearchOrder | the parameter processor enabler search order |
Errors | NULL_ARGUMENT | parameterProcessorEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | parameterProcessorEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorEnablerQueryFromInspector | ||
Description |
Gets a parameter processor enabler query from an inspector. | ||
Parameters | osid.configuration.rules.ParameterProcessorEnablerQueryInspector | parameterProcessorEnablerQueryInspector | a parameter processor enabler query inspector |
Return | osid.configuration.rules.ParameterProcessorEnablerQuery | the parameter processor enabler query | |
Errors | NULL_ARGUMENT | parameterProcessorEnablerQueryInspector is null
| |
UNSUPPORTED | parameterProcessorEnablerQueryInspector is not of this
service | ||
Compliance | mandatory | This method must be implemented. |