OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.ProcedureSearch
Implementsosid.OsidSearch
Description

The search interface for governing procedure searches.

MethodsearchAmongProcedures
Description

Execute this search among the given list of procedures.

Parametersosid.id.IdListprocedureIdslist of procedures
ErrorsNULL_ARGUMENT procedureIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProcedureResults
Description

Specify an ordering to the search results.

Parametersosid.recipe.ProcedureSearchOrderprocedureSearchOrderprocedure search order
ErrorsNULL_ARGUMENT procedureSearchOrder is null
UNSUPPORTED procedureSearchOrder is not of this service
CompliancemandatoryThis 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.TypeprocedureSearchRecordTypea procedure search record type
Returnosid.recipe.records.ProcedureSearchRecordthe procedure search record
ErrorsNULL_ARGUMENT procedureSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(procedureSearchRecordType) is false
CompliancemandatoryThis method must be implemented.