OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.ProcedureSearchSession
Implementsosid.recipe.ProcedureQuerySession
Description

This session provides methods for searching Procedure objects. The search query is constructed using the ProcedureQuery. The procedure record Type also specifies the record for the procedure query.

getProceduresByQuery() is the basic search method and returns a list of Cookbook elements. A more advanced search may be performed with getProceduresBySearch(). It accepts a ProcedureSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProceduresBySearch() returns a ProcedureSearchResults that can be used to access the resulting ProcedureList or be used to perform a search within the result set through ProcedureSearch.

Procedures may have a query record indicated by their respective record types. The query record is accessed via the ProcedureQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetProcedureSearch
Description

Gets a procedure search.

Returnosid.recipe.ProcedureSearchthe procedure search
CompliancemandatoryThis method must be implemented.
MethodgetProcedureSearchOrder
Description

Gets a procedure search order. The ProcedureSearchOrder is supplied to a ProcedureSearch to specify the ordering of results.

Returnosid.recipe.ProcedureSearchOrderthe procedure search order interface
CompliancemandatoryThis method must be implemented.
MethodgetProceduresBySearch
Description

Gets the search results matching the given search.

Parametersosid.recipe.ProcedureQueryprocedureQuerythe procedure query
osid.recipe.ProcedureSearchprocedureSearchthe procedure search
Returnosid.recipe.ProcedureSearchResultsthe procedure search results
ErrorsNULL_ARGUMENT procedureQuery or procedureSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED procedureQuery or procedureSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProcedureQueryFromInspector
Description

Gets a procedure query from an inspector. The inspector is available from a ProcedureSearchResults.

Parametersosid.recipe.ProcedureQueryInspectorprocedureQueryInspectora procedure query inspector
Returnosid.recipe.ProcedureQuerythe procedure query
ErrorsNULL_ARGUMENT procedureQueryInspector is null
UNSUPPORTED procedureQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.