Interface | osid.recipe.CookbookQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching for cook books. Each method
specifies an | ||
Method | matchRecipeId | ||
Description |
Sets the recipe | ||
Parameters | osid.id.Id | recipeId | a 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 recipe query is available. | ||
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. | ||
Return | osid.recipe.RecipeQuery | the recipe query | |
Errors | UNIMPLEMENTED | supportsRecipeQuery() is false | |
Compliance | optional | This method must be implemented if supportsRecipeQuery() is
true. | |
Method | matchAnyRecipe | ||
Description |
Matches cook books with any recipe. | ||
Parameters | boolean | match | true to match cook books with any recipe, false
to match cook books with no recipes |
Compliance | mandatory | This method must be implemented. | |
Method | clearRecipeTerms | ||
Description |
Clears the procedure terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchProcedureId | ||
Description |
Sets the procedure | ||
Parameters | osid.id.Id | procedureId | a 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 procedure query is available. | ||
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 an procedure. | ||
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 cook books with any procedure. | ||
Parameters | boolean | match | true to match cook books with any procedure, false
to match cook books with no procedures |
Compliance | mandatory | This method must be implemented. | |
Method | clearProcedureTerms | ||
Description |
Clears the procedure terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDirectionId | ||
Description |
Sets a direction | ||
Parameters | osid.id.Id | directionId | a direction Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | directionId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDirectionIdTerms | ||
Description |
Clears the direction | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a direction query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionQuery | ||
Description |
Gets the query for a direction query. Multiple
retrievals produce a nested | ||
Return | osid.recipe.DirectionQuery | the direction query | |
Errors | UNIMPLEMENTED | supportsDirectionQuery() is false | |
Compliance | optional | This method must be implemented if supportsDirectionQuery()
is true. | |
Method | matchAnyDirection | ||
Description |
Matches any direction. | ||
Parameters | boolean | match | true to match cook books with any direction, false
to match cook books with no directions |
Compliance | mandatory | This method must be implemented. | |
Method | clearDirectionTerms | ||
Description |
Clears the direction terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorCookbookId | ||
Description |
Sets the cook book | ||
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 | clearAncestorCookbookIdTerms | ||
Description |
Clears the ancestor cook book | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorCookbookQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a cook book query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorCookbookQuery | ||
Description |
Gets the query for a cookbook. Multiple retrievals
produce a nested | ||
Return | osid.recipe.CookbookQuery | the cook book query | |
Errors | UNIMPLEMENTED | supportsAncestorCookbookQuery() is false | |
Compliance | optional | This method must be implemented if supportsAncestorCookbookQuery()
is true. | |
Method | matchAnyAncestorCookbook | ||
Description |
Matches cook books with any ancestor. | ||
Parameters | boolean | match | true to match cook books with any ancestor, false
to match root cook books |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorCookbookTerms | ||
Description |
Clears the ancestor cook book terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantCookbookId | ||
Description |
Sets the cook book | ||
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 | clearDescendantCookbookIdTerms | ||
Description |
Clears the descendant cook book | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantCookbookQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a cook book query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantCookbookQuery | ||
Description |
Gets the query for a cookbook. Multiple retrievals
produce a nested | ||
Return | osid.recipe.CookbookQuery | the cook book query | |
Errors | UNIMPLEMENTED | supportsDescendantCookbookQuery() is false | |
Compliance | optional | This method must be implemented if supportsDescendantCookbookQuery()
is true. | |
Method | matchAnyDescendantCookbook | ||
Description |
Matches cook books with any descendant. | ||
Parameters | boolean | match | true to match cook books with any descendant, false
to match leaf cook books |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantCookbookTerms | ||
Description |
Clears the descendant cook book terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCookbookQueryRecord | ||
Description |
Gets the query record corresponding to the given | ||
Parameters | osid.type.Type | cookbookRecordType | a cook book record type |
Return | osid.recipe.records.CookbookQueryRecord | the cook book query record | |
Errors | NULL_ARGUMENT | cookbookRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(cookbookRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |