OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.InstallationSearchSession
Implementsosid.installation.InstallationQuerySession
Description

This session provides methods for searching Installations. The search query is constructed using the InstallationQuery. The installation record Type also specifies the record for the installation query.

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

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

MethodgetInstallationSearch
Description

Gets an installation search.

Returnosid.installation.InstallationSearchthe installation search
CompliancemandatoryThis method must be implemented.
MethodgetInstallationSearchOrder
Description

Gets an installation search order. The InstallationSearchOrder is supplied to an InstallationSearch to specify the ordering of results.

Returnosid.installation.InstallationSearchOrderthe installation search order
CompliancemandatoryThis method must be implemented.
MethodgetInstallationsBySearch
Description

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

Parametersosid.installation.InstallationQueryinstallationQuerythe installation query
osid.installation.InstallationSearchinstallationSearchthe installation search
Returnosid.installation.InstallationSearchResultsthe returned search results
ErrorsNULL_ARGUMENT installationQuery or installationSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED installationSearch or installationQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInstallationsQueryFromInspector
Description

Gets a installation query from an inspector. The inspector is available from a InstallationSearchResults.

Parametersosid.installation.InstallationQueryInspectorinstallatonQueryInspectora installation query inspector
Returnosid.installation.InstallationQuerythe installaton query
ErrorsNULL_ARGUMENT installationQueryInspector is null
UNSUPPORTED installationQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.