OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.ProcedureLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving procedures.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated cook book view: All procedure methods in this session operate, retrieve and pertain to procedures defined explicitly in the current cookbook. Using an isolated view is useful for managing procedures with the ProcedureAdminSession.
  • federated cook book view: All procedure lookup methods in this session operate, retrieve and pertain to all procedures defined in this cook book and any other cook books implicitly available in this cook book through cook book inheritence.

The methods useFederatedCookbookView() and useIsolatedCookbookView() behave as a radio group and one should be selected before invoking any lookup methods.

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.
MethodcanLookupProcedures
Description

Tests if this user can lookup procedures. 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 opt not to offer these operations.

Returnboolean false if procedure lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeProcedureView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryProcedureView
Description

A complete view of the Procedure returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is 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.
MethodgetProcedure
Description

Gets the Procedure specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Procedure may have a different Id than requested, such as the case where a duplicate Id was assigned to a Procedure and retained for compatibility.

Parametersosid.id.IdprocedureIdthe Id of the Procedure to retrieve
Returnosid.recipe.Procedurethe returned Procedure
ErrorsNOT_FOUNDno Procedure found with the given Id
NULL_ARGUMENT procedureId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProceduresByIds
Description

Gets a ProcedureList corresponding to the given IdList. In plenary mode, the returned list contains all of the procedures specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible procedures may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListprocedureIdsthe list of Ids to retrieve
Returnosid.recipe.ProcedureListthe returned Procedure list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT procedureIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProceduresByGenusType
Description

Gets a ProcedureList corresponding to the given procedure genus Type which does not include procedures of genus types derived from the specified Type. In plenary mode, the returned list contains all known procedures or an error results. Otherwise, the returned list may contain only those procedures that are accessible through this session.

Parametersosid.type.TypeprocedureGenusTypea procedure genus type
Returnosid.recipe.ProcedureListthe returned Procedure list
ErrorsNULL_ARGUMENT procedureGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProceduresByParentGenusType
Description

Gets a ProcedureList corresponding to the given procedure genus Type and include any additional procedures with genus types derived from the specified Type. In plenary mode, the returned list contains all known procedures or an error results. Otherwise, the returned list may contain only those procedures that are accessible through this session.

Parametersosid.type.TypeprocedureGenusTypea procedure genus type
Returnosid.recipe.ProcedureListthe returned Procedure list
ErrorsNULL_ARGUMENT procedureGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProceduresByRecordType
Description

Gets a ProcedureList containing the given procedure record Type. In plenary mode, the returned list contains all known procedures or an error results. Otherwise, the returned list may contain only those procedures that are accessible through this session.

Parametersosid.type.TypeprocedureRecordTypea procedure record type
Returnosid.recipe.ProcedureListthe returned Procedure list
ErrorsNULL_ARGUMENT procedureRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcedures
Description

Gets all procedures. In plenary mode, the returned list contains all known procedures or an error results. Otherwise, the returned list may contain only those procedures that are accessible through this session.

Returnosid.recipe.ProcedureLista list of procedures
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.