OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.ProcedureSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetProcedures
Description

Gets the procedure list resulting from a search.

Returnosid.recipe.ProcedureListthe procedure list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProcedureQueryInspector
Description

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

Returnosid.recipe.ProcedureQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetProcedureSearchResultsRecord
Description

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

Parametersosid.type.TypeprocedureSearchRecordTypea procedure search record type
Returnosid.recipe.records.ProcedureSearchResultsRecordthe procedure search record
ErrorsNULL_ARGUMENT procedureSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(procedureSearchRecordType) is false
CompliancemandatoryThis method must be implemented.