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

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

MethodmatchTotalEstimatedDuration
Description

Matches recipies 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.
MethodmatchAnyTotalEstimatedDuration
Description

Matches recipes 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.
MethodclearTotalEstimatedDurationTerms
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.
MethodmatchDirectionId
Description

Sets the direction Id for this query.

Parametersosid.id.IdqualifierIdthe 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 query 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. 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 recipes that have any direction.

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

Clears the direction query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTotalDuration
Description

Matches recipies 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.
MethodclearTotalDurationTerms
Description

Clears the duration query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCookbookId
Description

Sets the award Id for this query to match recipes 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.
MethodgetRecipeQueryRecord
Description

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

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