OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.InputSearch
Implementsosid.OsidSearch
Used Byosid.control.InputSearchSession
Description

The search interface for governing input searches.

MethodsearchAmongInputs
Description

Execute this search among the given list of inputs.

Parametersosid.id.IdListinputIds list of inputs
ErrorsNULL_ARGUMENT inputIds is null
Compliancemandatory This method must be implemented.
MethodorderInputResults
Description

Specify an ordering to the search results.

Parametersosid.control.InputSearchOrderinputSearchOrder input search order
ErrorsNULL_ARGUMENT inputSearchOrder is null
UNSUPPORTED inputSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetInputSearchRecord
Description

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

Parametersosid.type.TypeinputSearchRecordType an input search record type
Returnosid.control.records.InputSearchRecord the input search record
ErrorsNULL_ARGUMENT inputSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(inputSearchRecordType) is false
Compliancemandatory This method must be implemented.