Interface | osid.configuration.rules.ValueEnablerSmartConfigurationSession | ||
---|---|---|---|
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 | getValueEnablerQuery | ||
Description |
Gets a value enabler query. | ||
Return | osid.configuration.rules.ValueEnablerQuery | the value enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablerSearchOrder | ||
Description |
Gets a value enabler search order. | ||
Return | osid.configuration.rules.ValueEnablerSearchOrder | the value enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyValueEnablerQuery | ||
Description |
Applies a value enabler query to this configuration. | ||
Parameters | osid.configuration.rules.ValueEnablerQuery | valueEnablerQuery | the value enabler query |
Errors | NULL_ARGUMENT | valueEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | valueEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectValueEnablerQuery | ||
Description |
Gets a value enabler query inspector for this configuration. | ||
Return | osid.configuration.rules.ValueEnablerQueryInspector | the value enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyValueEnablerSequencing | ||
Description |
Applies a value enabler search order to this configuration. | ||
Parameters | osid.configuration.rules.ValueEnablerSearchOrder | valueEnablerSearchOrder | the value enabler search order |
Errors | NULL_ARGUMENT | valueEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | valueEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablerQueryFromInspector | ||
Description |
Gets a value enabler query from an inspector. | ||
Parameters | osid.configuration.rules.ValueEnablerQueryInspector | valueEnablerQueryInspector | a value enabler query inspector |
Return | osid.configuration.rules.ValueEnablerQuery | the value enabler query | |
Errors | NULL_ARGUMENT | valueEnablerQueryInspector is null | |
UNSUPPORTED | valueEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |