Interface | osid.recipe.DirectionQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching directions. Each method
match specifies an | ||
Method | matchRecipeId | ||
Description |
Sets the recipe | ||
Parameters | osid.id.Id | recipeId | the recipe Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | recipeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRecipeIdTerms | ||
Description |
Clears the recipe | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a recipe query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecipeQuery | ||
Description |
Gets the query for a recipe. Multiple retrievals
produce a nested | ||
Return | osid.recipe.RecipeQuery | the recipe query | |
Errors | UNIMPLEMENTED | supportsRecipeQuery() is false | |
Compliance | optional | This method must be implemented if supportsRecipeQuery() is
true. | |
Method | clearRecipeTerms | ||
Description |
Clears the recipe query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchProcedureId | ||
Description |
Sets the procedure | ||
Parameters | osid.id.Id | procedureId | the procedure Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | procedureId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearProcedureIdTerms | ||
Description |
Clears the procedure | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a procedure query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcedureQuery | ||
Description |
Gets the query for a procedure. Multiple retrievals
produce a nested | ||
Return | osid.recipe.ProcedureQuery | the procedure query | |
Errors | UNIMPLEMENTED | supportsProcedureQuery() is false | |
Compliance | optional | This method must be implemented if supportsProcedureQuery()
is true. | |
Method | matchAnyProcedure | ||
Description |
Matches directions with any procedure. | ||
Parameters | boolean | match | true to match directions with any procedure, false
to match directions with no procedures |
Compliance | mandatory | This method must be implemented. | |
Method | clearProcedureTerms | ||
Description |
Clears the procedure query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchIngredientId | ||
Description |
Sets the ingredient | ||
Parameters | osid.id.Id | ingredientId | the ingredient Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | ingredientId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearIngredientIdTerms | ||
Description |
Clears the ingredient | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsIngredientQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an ingredient query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getIngredientQuery | ||
Description |
Gets the query for an ingredient. Multiple retrievals
produce a nested | ||
Return | osid.recipe.IngredientQuery | the ingredient query | |
Errors | UNIMPLEMENTED | supportsIngredientItemQuery() is false | |
Compliance | optional | This method must be implemented if supportsIngredientQuery()
is true. | |
Method | matchAnyIngredient | ||
Description |
Matches directions with any ingredient. | ||
Parameters | boolean | match | true to match directions with any ingredient, false
to match directions with no ingredients |
Compliance | mandatory | This method must be implemented. | |
Method | clearIngredientTerms | ||
Description |
Clears the ingredient query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchEstimatedDuration | ||
Description |
Matches directions with an estimated duration between the given range inclusive. | ||
Parameters | osid.calendaring.Duration | start | starting duration |
osid.calendaring.Duration | end | ending duration | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | start or end is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyEstimatedDuration | ||
Description |
Matches directions with any estimated duration. | ||
Parameters | boolean | match | true to match directions with any estimated duration,
false to match directions with no estimated duration |
Compliance | mandatory | This method must be implemented. | |
Method | clearEstimatedDurationTerms | ||
Description |
Clears the duration query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAssetId | ||
Description |
Sets the asset | ||
Parameters | osid.id.Id | assetId | the asset Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | assetId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAssetIdTerms | ||
Description |
Clears the asset | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAssetQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an asset query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssetQuery | ||
Description |
Gets the query for an asset. Multiple retrievals
produce a nested | ||
Return | osid.repository.AssetQuery | the asset query | |
Errors | UNIMPLEMENTED | supportsAssetQuery() is false | |
Compliance | optional | This method must be implemented if supportsAssetQuery() is
true. | |
Method | matchAnyAsset | ||
Description |
Matches directions with any asset. | ||
Parameters | boolean | match | true to match directions with any asset, false
to match directions with no assets |
Compliance | mandatory | This method must be implemented. | |
Method | clearAssetTerms | ||
Description |
Clears the asset query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCookbookId | ||
Description |
Sets the award | ||
Parameters | osid.id.Id | cookbookId | a cook book Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | cookbookId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCookbookIdTerms | ||
Description |
Clears the cook book | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCookbookQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a cook book query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCookbookQuery | ||
Description |
Gets the query for a cookbook. Multiple retrievals
produce a nested | ||
Return | osid.recipe.CookbookQuery | the cook book query | |
Errors | UNIMPLEMENTED | supportsCookbookQuery() is false | |
Compliance | optional | This method must be implemented if supportsCookbookQuery()
is true. | |
Method | clearCookbookTerms | ||
Description |
Clears the cook book query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionQueryRecord | ||
Description |
Gets the direction query record corresponding to the
given | ||
Parameters | osid.type.Type | directionRecordType | a direction record type |
Return | osid.recipe.records.DirectionQueryRecord | the direction query record | |
Errors | NULL_ARGUMENT | directionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(directionRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |