OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.DirectionQuery
Implementsosid.OsidObjectQuery
osid.OsidSubjugateableQuery
Description

This is the query for searching directions. Each method match 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.IdrecipeIdthe 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 query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeQuery
Description

Tests if a RecipeQuery 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. Multiple retrievals produce a nested OR term.

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

Clears the recipe query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProcedureId
Description

Sets the procedure Id for this query.

Parametersosid.id.IdprocedureIdthe 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 query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureQuery
Description

Tests if a ProcedureQuery is available.

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

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

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

Matches directions with any procedure.

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

Clears the procedure query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchIngredientId
Description

Sets the ingredient Id.

Parametersosid.id.IdingredientIdthe ingredient Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT ingredientId is null
CompliancemandatoryThis method must be implemented.
MethodclearIngredientIdTerms
Description

Clears the ingredient Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsIngredientQuery
Description

Tests if an IngredientkQuery is available.

Returnboolean true if an ingredient query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetIngredientQuery
Description

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

Returnosid.recipe.IngredientQuerythe ingredient query
ErrorsUNIMPLEMENTED supportsIngredientItemQuery() is false
ComplianceoptionalThis method must be implemented if supportsIngredientQuery() is true.
MethodmatchAnyIngredient
Description

Matches directions with any ingredient.

Parametersbooleanmatch true to match directions with any ingredient, false to match directions with no ingredients
CompliancemandatoryThis method must be implemented.
MethodclearIngredientTerms
Description

Clears the ingredient query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEstimatedDuration
Description

Matches directions with an estimated duration between the given range inclusive.

Parametersosid.calendaring.Durationstartstarting duration
osid.calendaring.Durationendending duration
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyEstimatedDuration
Description

Matches directions with any estimated duration.

Parametersbooleanmatch true to match directions with any estimated duration, false to match directions with no estimated duration
CompliancemandatoryThis method must be implemented.
MethodclearEstimatedDurationTerms
Description

Clears the duration query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAssetId
Description

Sets the asset Id for this query.

Parametersosid.id.IdassetIdthe asset Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT assetId is null
CompliancemandatoryThis method must be implemented.
MethodclearAssetIdTerms
Description

Clears the asset Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAssetQuery
Description

Tests if an AssetQuery is available.

Returnboolean true if an asset query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAssetQuery
Description

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

Returnosid.repository.AssetQuerythe asset query
ErrorsUNIMPLEMENTED supportsAssetQuery() is false
ComplianceoptionalThis method must be implemented if supportsAssetQuery() is true.
MethodmatchAnyAsset
Description

Matches directions with any asset.

Parametersbooleanmatch true to match directions with any asset, false to match directions with no assets
CompliancemandatoryThis method must be implemented.
MethodclearAssetTerms
Description

Clears the asset query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCookbookId
Description

Sets the award Id for this query to match directions assigned to cookbooks.

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

Clears the cook book Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCookbookQuery
Description

Tests if a CookbookQuery is available.

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

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

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

Clears the cook book query terms.

CompliancemandatoryThis method must be implemented.
MethodgetDirectionQueryRecord
Description

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

Parametersosid.type.TypedirectionRecordTypea direction record type
Returnosid.recipe.records.DirectionQueryRecordthe direction query record
ErrorsNULL_ARGUMENT directionRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(directionRecordType) is false
CompliancemandatoryThis method must be implemented.