OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.CookbookQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for searching for cook books. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodgetRecipeIdTerms
Description

Gets the recipe Id terms.

Returnosid.search.terms.IdTerm[]the recipe Id terms
CompliancemandatoryThis method must be implemented.
MethodgetRecipeTerms
Description

Gets the recipe terms.

Returnosid.recipe.RecipeQueryInspector[]the recipe terms
CompliancemandatoryThis method must be implemented.
MethodgetProcedureIdTerms
Description

Gets the procedure Id terms.

Returnosid.search.terms.IdTerm[]the procedure Id terms
CompliancemandatoryThis method must be implemented.
MethodgetProcedureTerms
Description

Gets the procedure terms.

Returnosid.recipe.ProcedureQueryInspector[]the procedure terms
CompliancemandatoryThis method must be implemented.
MethodgetDirectionIdTerms
Description

Gets the direction Id terms.

Returnosid.search.terms.IdTerm[]the direction Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDirectionTerms
Description

Gets the direction terms.

Returnosid.recipe.DirectionQueryInspector[]the direction terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorCookbookIdTerms
Description

Gets the ancestor cook book Id terms.

Returnosid.search.terms.IdTerm[]the ancestor cook book Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorCookbookTerms
Description

Gets the ancestor cook book terms.

Returnosid.recipe.CookbookQueryInspector[]the ancestor cook book terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantCookbookIdTerms
Description

Gets the descendant cook book Id terms.

Returnosid.search.terms.IdTerm[]the descendant cook book Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantCookbookTerms
Description

Gets the descendant cook book terms.

Returnosid.recipe.CookbookQueryInspector[]the descendant cook book terms
CompliancemandatoryThis method must be implemented.
MethodgetCookbookQueryInspectorRecord
Description

Gets the query inspector record corresponding to the given Cookbook record Type.

Parametersosid.type.TypecookbookRecordTypea cook book record type
Returnosid.recipe.records.CookbookQueryInspectorRecordthe cook book query inspector record
ErrorsNULL_ARGUMENT cookbookRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cookbookRecordType) is false
CompliancemandatoryThis method must be implemented.