OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ConfigurationSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetConfigurations
Description

Gets the configuration list resulting from a search.

Returnosid.configuration.ConfigurationListthe configuration list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationQueryInspector
Description

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

Returnosid.configuration.ConfigurationQueryInspectorthe configuration query inspector
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationSearchResultsRecord
Description

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

Parametersosid.type.TypeconfigurationSearchRecordTypea configuration search record type
Returnosid.configuration.records.ConfigurationSearchResultsRecordthe configuration search results
ErrorsNULL_ARGUMENT configurationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(configurationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.