OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SystemSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetSystems
Description

Gets the system list resulting from a search.

Returnosid.control.SystemListthe system list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetSystemQueryInspector
Description

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

Returnosid.control.SystemQueryInspectorthe system query inspector
CompliancemandatoryThis 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.TypesystemSearchRecordTypea system search record type
Returnosid.control.records.SystemSearchResultsRecordthe system search results record
ErrorsNULL_ARGUMENT systemSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(systemSearchRecordType) is false
CompliancemandatoryThis method must be implemented.