Interface | osid.configuration.rules.ParameterProcessorSmartConfigurationSession | ||
---|---|---|---|
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 | getParameterProcessorQuery | ||
Description |
Gets a parameter processor query. | ||
Return | osid.configuration.rules.ParameterProcessorQuery | the parameter processor query | |
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorSearchOrder | ||
Description |
Gets a parameter processor search order. | ||
Return | osid.configuration.rules.ParameterProcessorSearchOrder | the parameter processor search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyParameterProcessorQuery | ||
Description |
Applies a parameter processor query to this configuration. | ||
Parameters | osid.configuration.rules.ParameterProcessorQuery | parameterProcessorQuery | the parameter processor query |
Errors | NULL_ARGUMENT | parameterProcessorQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | parameterProcessorQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectParameterProcessorQuery | ||
Description |
Gets a parameter processor query inspector for this configuration. | ||
Return | osid.configuration.rules.ParameterProcessorQueryInspector | the parameter processor query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyParameterProcessorSequencing | ||
Description |
Applies a parameter processor search order to this configuration. | ||
Parameters | osid.configuration.rules.ParameterProcessorSearchOrder | parameterProcessorSearchOrder | the parameter processor search order |
Errors | NULL_ARGUMENT | parameterProcessorSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | parameterProcessorSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorQueryFromInspector | ||
Description |
Gets a parameter processor query from an inspector. | ||
Parameters | osid.configuration.rules.ParameterProcessorQueryInspector | parameterProcessorQueryInspector | a parameter processor query inspector |
Return | osid.configuration.rules.ParameterProcessorQuery | the parameter processor query | |
Errors | NULL_ARGUMENT | parameterProcessorQueryInspector is null | |
UNSUPPORTED | parameterProcessorQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |