OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SettingSearchSession
Implementsosid.control.SettingQuerySession
Description

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

getSettingsByQuery() is the basic search method and returns a list of Settings. A more advanced search may be performed with getSettingsBySearch(). It accepts an SettingSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getSettingsBySearch() returns an SettingSearchResults that can be used to access the resulting SettingList or be used to perform a search within the result set through SettingSearch.

This session defines views that offer differing behaviors for searching.

  • federated system view: searches include settings in systems of which this system is an ancestor in the system hierarchy
  • isolated system view: searches are restricted to settings in this system

Settings may have a query record indicated by their respective record types. The query record is accessed via the SettingQuery.

MethodgetSettingSearch
Description

Gets a setting search.

Returnosid.control.SettingSearchthe setting search
CompliancemandatoryThis method must be implemented.
MethodgetSettingSearchOrder
Description

Gets a setting search order. The SettingSearchOrder is supplied to a SettingSearch to specify the ordering of results.

Returnosid.control.SettingSearchOrderthe setting search order
CompliancemandatoryThis method must be implemented.
MethodgetSettingsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.control.SettingQuerysettingQuerythe setting query
osid.control.SettingSearchsettingSearchthe setting search
Returnosid.control.SettingSearchResultsthe returned search results
ErrorsNULL_ARGUMENT settingQuery or settingSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED settingQuery or settingSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSettingQueryFromInspector
Description

Gets a setting query from an inspector. The inspector is available from a SettingSearchResults.

Parametersosid.control.SettingQueryInspectorsettingQueryInspectora setting query inspector
Returnosid.control.SettingQuerythe setting query
ErrorsNULL_ARGUMENT settingQueryInspector is null
UNSUPPORTED settingQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.