OSID Logo
OSID Specifications
process package
Version 3.1.0
Interfaceosid.process.StateSearchResults
Implementsosid.OsidSearchResults
Used Byosid.process.StateSearchSession
Description

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

MethodgetStates
Description

Gets the state list resulting from a search.

Returnosid.process.StateList the state list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetStateQueryInspector
Description

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

Returnosid.process.StateQueryInspector the state query inspector
Compliancemandatory This 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.TypestateSearchRecordType a state search record type
Returnosid.process.records.StateSearchResultsRecord the state search results record
ErrorsNULL_ARGUMENT stateSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(stateSearchRecordType) is false
Compliancemandatory This method must be implemented.