OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ConfigurationSearchSession
Implementsosid.configuration.ConfigurationQuerySession
Description

This session provides methods for searching among Configuration objects. The search query is constructed using the ConfigurationQuery.

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 ConfigurationQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetConfigurationSearch
Description

Gets a configuration search.

Returnosid.configuration.ConfigurationSearchthe configuration search
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationSearchOrder
Description

Gets a log search order. The ConfigurationSearchOrder is supplied to a ConfigurationSearch to specify the ordering of results.

Returnosid.configuration.ConfigurationSearchOrderthe configuration search order
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationsBySearch
Description

Gets a list of Configurations matching the given search. Each element in the array is OR'd.

Parametersosid.configuration.ConfigurationQueryconfigurationQuerythe configuration query
osid.configuration.ConfigurationSearchconfigurationSearchthe configuration search
Returnosid.configuration.ConfigurationSearchResultsthe configuration search results
ErrorsNULL_ARGUMENT configurationQuery or configurationSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED configurationQuery or configurationSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationQueryFromInspector
Description

Gets a configuration query from an inspector. The inspector is available from a ConfigurationSearchResults.

Parametersosid.configuration.ConfigurationQueryInspectorconfigurationQueryInspectora configuration query inspector
Returnosid.configuration.ConfigurationQuerythe configuration query
ErrorsNULL_ARGUMENT configurationQueryInspector is null
UNSUPPORTED configurationQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.