OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.ProcedureQuerySession
Implementsosid.OsidSession
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 award query.

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.

MethodgetCookbookId
Description

Gets the Cookbook Id associated with this session.

Returnosid.id.Idthe Cookbook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCookbook
Description

Gets the Cookbook associated with this session.

Returnosid.recipe.Cookbookthe cookbook
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchProcedures
Description

Tests if this user can perform susbcription searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCookbookView
Description

Federates the view for methods in this session. A federated view will include procedures in cook books which are children of this cook book in the cook book hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCookbookView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this cook book only.

CompliancemandatoryThis method is must be implemented.
MethodgetProcedureQuery
Description

Gets a procedure query.

Returnosid.recipe.ProcedureQuerythe procedure query
CompliancemandatoryThis method must be implemented.
MethodgetProceduresByQuery
Description

Gets a list of procedures matching the given procedure query.

Parametersosid.recipe.ProcedureQueryprocedureQuerythe procedure query
Returnosid.recipe.ProcedureListthe returned ProcedureList
ErrorsNULL_ARGUMENT procedureQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED procedureQuery is not of this service
CompliancemandatoryThis method must be implemented.