OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.ModelSearch
Implementsosid.OsidSearch
Description

The search interface for governing model searches.

MethodsearchAmongModels
Description

Execute this search among the given list of models.

Parametersosid.id.IdListmodelIdslist of models
ErrorsNULL_ARGUMENT modelIds is null
CompliancemandatoryThis method must be implemented.
MethodorderModelResults
Description

Specify an ordering to the search results.

Parametersosid.inventory.ModelSearchOrdermodelSearchOrdermodel search order
ErrorsNULL_ARGUMENT modelSearchOrder is null
UNSUPPORTED modelSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetModelSearchRecord
Description

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

Parametersosid.type.TypemodelSearchRecordTypea model search record type
Returnosid.inventory.records.ModelSearchRecordthe model search record
ErrorsNULL_ARGUMENT modelSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(modelSearchRecordType) is false
CompliancemandatoryThis method must be implemented.