OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.InputSearchResults
Implementsosid.OsidSearchResults
Used Byosid.control.InputSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetInputs
Description

Gets the input list resulting from a search.

Returnosid.control.InputList the input list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetInputQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.control.InputQueryInspector the input query inspector
Compliancemandatory This method must be implemented.
MethodgetInputSearchResultsRecord
Description

Gets the input search results 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.InputSearchResultsRecord the input search results record
ErrorsNULL_ARGUMENT inputSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(inputSearchRecordType) is false
Compliancemandatory This method must be implemented.