OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.CookbookQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchRecipeId
Description

Sets the recipe Id for this query.

Parametersosid.id.IdrecipeIda recipe Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT recipeId is null
CompliancemandatoryThis method must be implemented.
MethodclearRecipeIdTerms
Description

Clears the recipe Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeQuery
Description

Tests if a recipe query is available.

Returnboolean true if a recipe query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRecipeQuery
Description

Gets the query for a recipe.

Returnosid.recipe.RecipeQuerythe recipe query
ErrorsUNIMPLEMENTED supportsRecipeQuery() is false
ComplianceoptionalThis method must be implemented if supportsRecipeQuery() is true.
MethodmatchAnyRecipe
Description

Matches cook books with any recipe.

Parametersbooleanmatch true to match cook books with any recipe, false to match cook books with no recipes
CompliancemandatoryThis method must be implemented.
MethodclearRecipeTerms
Description

Clears the procedure terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProcedureId
Description

Sets the procedure Id for this query to match procedures assigned to cook books.

Parametersosid.id.IdprocedureIda procedure Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT procedureId is null
CompliancemandatoryThis method must be implemented.
MethodclearProcedureIdTerms
Description

Clears the procedure Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureQuery
Description

Tests if a procedure query is available.

Returnboolean true if a procedure query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProcedureQuery
Description

Gets the query for an procedure.

Returnosid.recipe.ProcedureQuerythe procedure query
ErrorsUNIMPLEMENTED supportsProcedureQuery() is false
ComplianceoptionalThis method must be implemented if supportsProcedureQuery() is true.
MethodmatchAnyProcedure
Description

Matches cook books with any procedure.

Parametersbooleanmatch true to match cook books with any procedure, false to match cook books with no procedures
CompliancemandatoryThis method must be implemented.
MethodclearProcedureTerms
Description

Clears the procedure terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDirectionId
Description

Sets a direction Id.

Parametersosid.id.IddirectionIda direction Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT directionId is null
CompliancemandatoryThis method must be implemented.
MethodclearDirectionIdTerms
Description

Clears the direction Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionQuery
Description

Tests if a DirectionQuery is available.

Returnboolean true if a direction query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDirectionQuery
Description

Gets the query for a direction query. Multiple retrievals produce a nested OR term.

Returnosid.recipe.DirectionQuerythe direction query
ErrorsUNIMPLEMENTED supportsDirectionQuery() is false
ComplianceoptionalThis method must be implemented if supportsDirectionQuery() is true.
MethodmatchAnyDirection
Description

Matches any direction.

Parametersbooleanmatch true to match cook books with any direction, false to match cook books with no directions
CompliancemandatoryThis method must be implemented.
MethodclearDirectionTerms
Description

Clears the direction terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorCookbookId
Description

Sets the cook book Id for this query to match cook books that have the specified cook book as an ancestor.

Parametersosid.id.IdcookbookIda cook book Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT cookbookId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorCookbookIdTerms
Description

Clears the ancestor cook book Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorCookbookQuery
Description

Tests if an CookbookQuery is available.

Returnboolean true if a cook book query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorCookbookQuery
Description

Gets the query for a cookbook. Multiple retrievals produce a nested OR term.

Returnosid.recipe.CookbookQuerythe cook book query
ErrorsUNIMPLEMENTED supportsAncestorCookbookQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorCookbookQuery() is true.
MethodmatchAnyAncestorCookbook
Description

Matches cook books with any ancestor.

Parametersbooleanmatch true to match cook books with any ancestor, false to match root cook books
CompliancemandatoryThis method must be implemented.
MethodclearAncestorCookbookTerms
Description

Clears the ancestor cook book terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantCookbookId
Description

Sets the cook book Id for this query to match cook books that have the specified cook book as a descendant.

Parametersosid.id.IdcookbookIda cook book Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT cookbookId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantCookbookIdTerms
Description

Clears the descendant cook book Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantCookbookQuery
Description

Tests if an CookbookQuery is available.

Returnboolean true if a cook book query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantCookbookQuery
Description

Gets the query for a cookbook. Multiple retrievals produce a nested OR term.

Returnosid.recipe.CookbookQuerythe cook book query
ErrorsUNIMPLEMENTED supportsDescendantCookbookQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantCookbookQuery() is true.
MethodmatchAnyDescendantCookbook
Description

Matches cook books with any descendant.

Parametersbooleanmatch true to match cook books with any descendant, false to match leaf cook books
CompliancemandatoryThis method must be implemented.
MethodclearDescendantCookbookTerms
Description

Clears the descendant cook book terms.

CompliancemandatoryThis method must be implemented.
MethodgetCookbookQueryRecord
Description

Gets the query record corresponding to the given Cookbook record Type. Multiple record retrievals produce a nested boolean OR term.

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