OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.InstallationSearch
Implementsosid.OsidSearch
Description

InstallationSearch defines the interface for specifying installation search options.

MethodsearchAmongInstallations
Description

Execute this search among the given list of installations.

Parametersosid.id.IdListinstallationIdslist of installations
ErrorsNULL_ARGUMENT installationIds is null
CompliancemandatoryThis method must be implemented.
MethodorderInstallationResults
Description

Specify an ordering to the search results.

Parametersosid.installation.InstallationSearchOrderinstallationSearchOrderinstallation search order
ErrorsNULL_ARGUMENT installationSearchOrder is null
UNSUPPORTED installationSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInstallationSearchRecord
Description

Gets the installation search record corresponding to the given installation search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeinstallationSearchRecordTypean installation search record type
Returnosid.installation.records.InstallationSearchRecordthe installation search record
ErrorsNULL_ARGUMENT installationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(installationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.