OSID Logo
OSID Specifications
configuration package
Version 3.1.0
Interfaceosid.configuration.ConfigurationSearchResults
Implementsosid.OsidSearchResults
Used Byosid.configuration.ConfigurationSearchSession
Description

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

MethodgetConfigurations
Description

Gets the configuration list resulting from a search.

Returnosid.configuration.ConfigurationList the configuration list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetConfigurationQueryInspector
Description

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

Returnosid.configuration.ConfigurationQueryInspector the configuration query inspector
Compliancemandatory This 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.TypeconfigurationSearchRecordType a configuration search record type
Returnosid.configuration.records.ConfigurationSearchResultsRecord the configuration search results
ErrorsNULL_ARGUMENT configurationSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(configurationSearchRecordType) is false
Compliancemandatory This method must be implemented.