OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.InputSearch
Implementsosid.OsidSearch
Description

The search interface for governing input searches.

MethodsearchAmongInputs
Description

Execute this search among the given list of inputs.

Parametersosid.id.IdListinputIdslist of inputs
ErrorsNULL_ARGUMENT inputIds is null
CompliancemandatoryThis method must be implemented.
MethodorderInputResults
Description

Specify an ordering to the search results.

Parametersosid.control.InputSearchOrderinputSearchOrderinput search order
ErrorsNULL_ARGUMENT inputSearchOrder is null
UNSUPPORTED inputSearchOrder is not of this service
CompliancemandatoryThis 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.TypeinputSearchRecordTypean input search record type
Returnosid.control.records.InputSearchRecordthe input search record
ErrorsNULL_ARGUMENT inputSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inputSearchRecordType) is false
CompliancemandatoryThis method must be implemented.