Interface | osid.configuration.ParameterQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching Two views of the configuration data are defined;
| ||
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 associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchParameters | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedConfigurationView | ||
Description |
Federates the view for methods in this session. A federated view will include parameters from parent configurations in the configuration hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedConfigurationView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this configuration only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getParameterQuery | ||
Description |
Gets a paraameter query. | ||
Return | osid.configuration.ParameterQuery | the parameter query | |
Compliance | mandatory | This method must be implemented. | |
Method | getParametersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.configuration.ParameterQuery | parameterQuery | the parameter query |
Return | osid.configuration.ParameterList | the returned ParameterList | |
Errors | NULL_ARGUMENT | parameterQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | a query form is not of this service | ||
Compliance | mandatory | This method must be implemented. |