OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.SystemSearchResults
Implementsosid.OsidSearchResults
Used Byosid.control.SystemSearchSession
Description

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

MethodgetSystems
Description

Gets the system list resulting from a search.

Returnosid.control.SystemList the system list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetSystemQueryInspector
Description

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

Returnosid.control.SystemQueryInspector the system query inspector
Compliancemandatory This method must be implemented.
MethodgetSystemSearchResultsRecord
Description

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

Parametersosid.type.TypesystemSearchRecordType a system search record type
Returnosid.control.records.SystemSearchResultsRecord the system search results record
ErrorsNULL_ARGUMENT systemSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(systemSearchRecordType) is false
Compliancemandatory This method must be implemented.