OSID Specifications
recipe package
Version 3.1.0
recipe package
Version 3.1.0
| Interface | osid.recipe.CookbookQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Used By | osid.recipe.CookbookQueryInspector | ||
osid.recipe.CookbookSearchResults | |||
osid.recipe.DirectionQueryInspector | |||
osid.recipe.ProcedureQueryInspector | |||
osid.recipe.RecipeQueryInspector | |||
| Description |
This is the query inspector for searching for cookbooks.
Each method specifies an | ||
| Method | getRecipeIdTerms | ||
| Description |
Gets the recipe | ||
| Return | osid.search.terms.IdTerm[] | the recipe Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecipeTerms | ||
| Description |
Gets the recipe terms. | ||
| Return | osid.recipe.RecipeQueryInspector[] | the recipe terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcedureIdTerms | ||
| Description |
Gets the procedure | ||
| Return | osid.search.terms.IdTerm[] | the procedure Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcedureTerms | ||
| Description |
Gets the procedure terms. | ||
| Return | osid.recipe.ProcedureQueryInspector[] | the procedure terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDirectionIdTerms | ||
| Description |
Gets the direction | ||
| Return | osid.search.terms.IdTerm[] | the direction Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDirectionTerms | ||
| Description |
Gets the direction terms. | ||
| Return | osid.recipe.DirectionQueryInspector[] | the direction terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorCookbookIdTerms | ||
| Description |
Gets the ancestor cookbook | ||
| Return | osid.search.terms.IdTerm[] | the ancestor cookbook Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorCookbookTerms | ||
| Description |
Gets the ancestor cookbook terms. | ||
| Return | osid.recipe.CookbookQueryInspector[] | the ancestor cookbook terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantCookbookIdTerms | ||
| Description |
Gets the descendant cookbook | ||
| Return | osid.search.terms.IdTerm[] | the descendant cookbook Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantCookbookTerms | ||
| Description |
Gets the descendant cookbook terms. | ||
| Return | osid.recipe.CookbookQueryInspector[] | the descendant cookbook terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCookbookQueryInspectorRecord | ||
| Description |
Gets the query inspector record corresponding to the
given | ||
| Parameters | osid.type.Type | cookbookRecordType | a cookbook record type |
| Return | osid.recipe.records.CookbookQueryInspectorRecord | the cookbook query inspector 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. | |