Interface | osid.recipe.RecipeProfile | ||
---|---|---|---|
Implements | osid.OsidProfile | ||
Description |
The recipe profile describes the interoperability among recipe services. | ||
Method | supportsVisibleFederation | ||
Description |
Tests if any cook book federation is exposed. Federation is exposed when a specific cook book may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of cook books appears as a single cookbook. | ||
Return | boolean | true if visible federation is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeLookup | ||
Description |
Tests if looking up recipes is supported. | ||
Return | boolean | true if recipe lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeQuery | ||
Description |
Tests if querying recipes is supported. | ||
Return | boolean | true if recipe query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeSearch | ||
Description |
Tests if searching recipes is supported. | ||
Return | boolean | true if recipe search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeAdmin | ||
Description |
Tests if recipe administrative service is supported. | ||
Return | boolean | true if recipe administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeNotification | ||
Description |
Tests if a recipe notification service is supported. | ||
Return | boolean | true if recipe notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeCookbook | ||
Description |
Tests if a recipe cook book lookup service is supported. | ||
Return | boolean | true if a recipe cook book lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeCookbookAssignment | ||
Description |
Tests if a recipe cook book service is supported. | ||
Return | boolean | true if recipe to cook book assignment service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeSmartCookbook | ||
Description |
Tests if a recipe smart cook book lookup service is supported. | ||
Return | boolean | true if a recipe smart cook book service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionLookup | ||
Description |
Tests if looking up directions is supported. | ||
Return | boolean | true if direction lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionQuery | ||
Description |
Tests if querying directions is supported. | ||
Return | boolean | true if direction query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionSearch | ||
Description |
Tests if searching directions is supported. | ||
Return | boolean | true if direction search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionAdmin | ||
Description |
Tests if direction | ||
Return | boolean | true if direction administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionNotification | ||
Description |
Tests if a direction | ||
Return | boolean | true if direction notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionCookbook | ||
Description |
Tests if a direction cook book lookup service is supported. | ||
Return | boolean | true if a direction cook book lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionCookbookAssignment | ||
Description |
Tests if a direction cook book assignment service is supported. | ||
Return | boolean | true if a direction to cook book assignment service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionSmartCookbook | ||
Description |
Tests if a direction smart cook book service is supported. | ||
Return | boolean | true if a direction smart cook book service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureLookup | ||
Description |
Tests for the availability of a procedure lookup service. | ||
Return | boolean | true if procedure lookup is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureQuery | ||
Description |
Tests if querying procedures is available. | ||
Return | boolean | true if procedure query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureSearch | ||
Description |
Tests if searching for procedures is available. | ||
Return | boolean | true if procedure search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureAdmin | ||
Description |
Tests if searching for procedures is available. | ||
Return | boolean | true if procedure search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureNotification | ||
Description |
Tests if procedure notification is available. | ||
Return | boolean | true if procedure notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureCookbook | ||
Description |
Tests if a procedure to cook book lookup session is available. | ||
Return | boolean | true if procedure cook book lookup session is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureCookbookAssignment | ||
Description |
Tests if a procedure to cook book assignment session is available. | ||
Return | boolean | true if procedure cook book assignment is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureSmartCookbook | ||
Description |
Tests if a procedure smart cook book session is available. | ||
Return | boolean | true if procedure smart cook book is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCookbookLookup | ||
Description |
Tests for the availability of a cook book lookup service. | ||
Return | boolean | true if cook book lookup is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCookbookQuery | ||
Description |
Tests if querying cook books is available. | ||
Return | boolean | true if cook book query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCookbookSearch | ||
Description |
Tests if searching for cook books is available. | ||
Return | boolean | true if cook book search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCookbookAdmin | ||
Description |
Tests for the availability of a cook book administrative service for creating and deleting cook books. | ||
Return | boolean | true if cook book administration is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCookbookNotification | ||
Description |
Tests for the availability of a cook book notification service. | ||
Return | boolean | true if cook book notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | supportsCookbookHierarchy | ||
Description |
Tests for the availability of a cook book hierarchy traversal service. | ||
Return | boolean | true if cook book hierarchy traversal is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCookbookHierarchyDesign | ||
Description |
Tests for the availability of a cook book hierarchy design service. | ||
Return | boolean | true if cook book hierarchy design is available,
false otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | supportsRecipieBatch | ||
Description |
Tests for the availability of a batch recipie service. | ||
Return | boolean | true if a batch recipie service is available, false
otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | getRecipeRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Recipe record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | recipeRecordType | a Type indicating an Recipe record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | recipeRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRecipeSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Recipe search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRecipeSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | recipeSearchRecordType | a Type indicating an Recipe search record
type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | recipeSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Direction record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | directionRecordType | a Type indicating a Direction record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | directionRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Direction search types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectionSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | directionSearchRecordType | a Type indicating a Direction search type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | directionSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getIngredientRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Ingredient record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsIngredientRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | ingredientRecordType | a Type indicating an Ingredient record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | ingredientRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcedureRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported procedure record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | procedureRecordType | a Type indicating a Procedure record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | procedureRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcedureSearchRecordTypes | ||
Description |
Gets the supported procedure search record types. | ||
Return | osid.type.TypeList | a list containing the supported procedure search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProcedureSearchRecordType | ||
Description |
Tests if the given procedure search record type is supported. | ||
Parameters | osid.type.Type | procedureSearchRecordType | a Type indicating a procedure record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | procedureSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCookbookRecordTypes | ||
Description |
Gets the supported cook book record types. | ||
Return | osid.type.TypeList | a list containing the supported cook book record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCookbookRecordType | ||
Description |
Tests if the given cook book record type is supported. | ||
Parameters | osid.type.Type | cookbookRecordType | a Type indicating a cook book record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | cookbookRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCookbookSearchRecordTypes | ||
Description |
Gets the supported cook book search record types. | ||
Return | osid.type.TypeList | a list containing the supported cook book search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCookbookSearchRecordType | ||
Description |
Tests if the given cook book search record type is supported. | ||
Parameters | osid.type.Type | cookbookSearchRecordType | a Type indicating a cook book record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | cookbookSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. |