OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.ProcedureSearch
Implementsosid.OsidSearch
Used Byosid.recipe.ProcedureSearchSession
Description

The search interface for governing procedure searches.

MethodsearchAmongProcedures
Description

Execute this search among the given list of procedures.

Parametersosid.id.IdListprocedureIds list of procedures
ErrorsNULL_ARGUMENT procedureIds is null
Compliancemandatory This method must be implemented.
MethodorderProcedureResults
Description

Specify an ordering to the search results.

Parametersosid.recipe.ProcedureSearchOrderprocedureSearchOrder procedure search order
ErrorsNULL_ARGUMENT procedureSearchOrder is null
UNSUPPORTED procedureSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetProcedureSearchRecord
Description

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

Parametersosid.type.TypeprocedureSearchRecordType a procedure search record type
Returnosid.recipe.records.ProcedureSearchRecord the procedure search record
ErrorsNULL_ARGUMENT procedureSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(procedureSearchRecordType) is false
Compliancemandatory This method must be implemented.