| Interface | osid.configuration.ConfigurationSearchSession | ||
|---|---|---|---|
| Implements | osid.configuration.ConfigurationQuerySession | ||
| Used By | osid.configuration.ConfigurationManager | ||
osid.configuration.ConfigurationProxyManager | |||
| Description |
This session provides methods for searching among
getConfigurationsByQuery() is the basic search
method and returns a list of Configuration
objects.A more advanced search may be performed with
getConfigurationsBySearch(). It accepts a
ConfigurationSearch in addition to the query for
the purpose of specifying additional options affecting the
entire search, such as ordering.
getConfigurationsBySearch() returns a
ConfigurationSearchResults that can be used to
access the resulting ConfigurationList or be used
to perform a search within the result set through
ConfigurationSearch.
Configurations may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getConfigurationSearch | ||
| Description |
Gets a configuration search. | ||
| Return | osid.configuration.ConfigurationSearch | the configuration search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConfigurationSearchOrder | ||
| Description |
Gets a log search order. The
| ||
| Return | osid.configuration.ConfigurationSearchOrder | the configuration search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConfigurationsBySearch | ||
| Description |
Gets a list of | ||
| Parameters | osid.configuration.ConfigurationQuery | configurationQuery | the configuration query |
osid.configuration.ConfigurationSearch | configurationSearch | the configuration search | |
| Return | osid.configuration.ConfigurationSearchResults | the configuration search results | |
| Errors | NULL_ARGUMENT | configurationQuery or configurationSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | configurationQuery or configurationSearch is not
of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getConfigurationQueryFromInspector | ||
| Description |
Gets a configuration query from an inspector. The
inspector is available from a
| ||
| Parameters | osid.configuration.ConfigurationQueryInspector | configurationQueryInspector | a configuration query inspector |
| Return | osid.configuration.ConfigurationQuery | the configuration query | |
| Errors | NULL_ARGUMENT | configurationQueryInspector is null | |
| UNSUPPORTED | configurationQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |