OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.StateSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetStates
Description

Gets the state list resulting from a search.

Returnosid.process.StateListthe state list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetStateQueryInspector
Description

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

Returnosid.process.StateQueryInspectorthe state query inspector
CompliancemandatoryThis method must be implemented.
MethodgetStateSearchResultsRecord
Description

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

Parametersosid.type.TypestateSearchRecordTypea state search record type
Returnosid.process.records.StateSearchResultsRecordthe state search results record
ErrorsNULL_ARGUMENT stateSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(stateSearchRecordType) is false
CompliancemandatoryThis method must be implemented.