OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.RecipeProfile
Implementsosid.OsidProfile
Description

The recipe profile describes the interoperability among recipe services.

MethodsupportsVisibleFederation
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.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeLookup
Description

Tests if looking up recipes is supported.

Returnboolean true if recipe lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeQuery
Description

Tests if querying recipes is supported.

Returnboolean true if recipe query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeSearch
Description

Tests if searching recipes is supported.

Returnboolean true if recipe search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeAdmin
Description

Tests if recipe administrative service is supported.

Returnboolean true if recipe administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeNotification
Description

Tests if a recipe notification service is supported.

Returnboolean true if recipe notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeCookbook
Description

Tests if a recipe cook book lookup service is supported.

Returnboolean true if a recipe cook book lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeCookbookAssignment
Description

Tests if a recipe cook book service is supported.

Returnboolean true if recipe to cook book assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeSmartCookbook
Description

Tests if a recipe smart cook book lookup service is supported.

Returnboolean true if a recipe smart cook book service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionLookup
Description

Tests if looking up directions is supported.

Returnboolean true if direction lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionQuery
Description

Tests if querying directions is supported.

Returnboolean true if direction query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionSearch
Description

Tests if searching directions is supported.

Returnboolean true if direction search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionAdmin
Description

Tests if direction administrative service is supported.

Returnboolean true if direction administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionNotification
Description

Tests if a direction notification service is supported.

Returnboolean true if direction notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionCookbook
Description

Tests if a direction cook book lookup service is supported.

Returnboolean true if a direction cook book lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionCookbookAssignment
Description

Tests if a direction cook book assignment service is supported.

Returnboolean true if a direction to cook book assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionSmartCookbook
Description

Tests if a direction smart cook book service is supported.

Returnboolean true if a direction smart cook book service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureLookup
Description

Tests for the availability of a procedure lookup service.

Returnboolean true if procedure lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureQuery
Description

Tests if querying procedures is available.

Returnboolean true if procedure query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureSearch
Description

Tests if searching for procedures is available.

Returnboolean true if procedure search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureAdmin
Description

Tests if searching for procedures is available.

Returnboolean true if procedure search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureNotification
Description

Tests if procedure notification is available.

Returnboolean true if procedure notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureCookbook
Description

Tests if a procedure to cook book lookup session is available.

Returnboolean true if procedure cook book lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureCookbookAssignment
Description

Tests if a procedure to cook book assignment session is available.

Returnboolean true if procedure cook book assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureSmartCookbook
Description

Tests if a procedure smart cook book session is available.

Returnboolean true if procedure smart cook book is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCookbookLookup
Description

Tests for the availability of a cook book lookup service.

Returnboolean true if cook book lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCookbookQuery
Description

Tests if querying cook books is available.

Returnboolean true if cook book query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCookbookSearch
Description

Tests if searching for cook books is available.

Returnboolean true if cook book search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCookbookAdmin
Description

Tests for the availability of a cook book administrative service for creating and deleting cook books.

Returnboolean true if cook book administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCookbookNotification
Description

Tests for the availability of a cook book notification service.

Returnboolean true if cook book notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsCookbookHierarchy
Description

Tests for the availability of a cook book hierarchy traversal service.

Returnboolean true if cook book hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCookbookHierarchyDesign
Description

Tests for the availability of a cook book hierarchy design service.

Returnboolean true if cook book hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsRecipieBatch
Description

Tests for the availability of a batch recipie service.

Returnboolean true if a batch recipie service is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodgetRecipeRecordTypes
Description

Gets the supported Recipe record types.

Returnosid.type.TypeLista list containing the supported Recipe record types
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeRecordType
Description

Tests if the given Recipe record type is supported.

Parametersosid.type.TyperecipeRecordTypea Type indicating an Recipe record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT recipeRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetRecipeSearchRecordTypes
Description

Gets the supported Recipe search record types.

Returnosid.type.TypeLista list containing the supported Recipe search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsRecipeSearchRecordType
Description

Tests if the given Recipe search record type is supported.

Parametersosid.type.TyperecipeSearchRecordTypea Type indicating an Recipe search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT recipeSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetDirectionRecordTypes
Description

Gets the supported Direction record types.

Returnosid.type.TypeLista list containing the supported Direction record types
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionRecordType
Description

Tests if the given Direction record type is supported.

Parametersosid.type.TypedirectionRecordTypea Type indicating a Direction record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT directionRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetDirectionSearchRecordTypes
Description

Gets the supported Direction search types.

Returnosid.type.TypeLista list containing the supported Direction search types
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectionSearchRecordType
Description

Tests if the given Direction search type is supported.

Parametersosid.type.TypedirectionSearchRecordTypea Type indicating a Direction search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT directionSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetIngredientRecordTypes
Description

Gets the supported Ingredient record types.

Returnosid.type.TypeLista list containing the supported Ingredient record types
CompliancemandatoryThis method must be implemented.
MethodsupportsIngredientRecordType
Description

Tests if the given Ingredient record type is supported.

Parametersosid.type.TypeingredientRecordTypea Type indicating an Ingredient record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT ingredientRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetProcedureRecordTypes
Description

Gets the supported Procedure record types.

Returnosid.type.TypeLista list containing the supported procedure record types
CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureRecordType
Description

Tests if the given Procedure record type is supported.

Parametersosid.type.TypeprocedureRecordTypea Type indicating a Procedure record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT procedureRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetProcedureSearchRecordTypes
Description

Gets the supported procedure search record types.

Returnosid.type.TypeLista list containing the supported procedure search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsProcedureSearchRecordType
Description

Tests if the given procedure search record type is supported.

Parametersosid.type.TypeprocedureSearchRecordTypea Type indicating a procedure record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT procedureSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCookbookRecordTypes
Description

Gets the supported cook book record types.

Returnosid.type.TypeLista list containing the supported cook book record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCookbookRecordType
Description

Tests if the given cook book record type is supported.

Parametersosid.type.TypecookbookRecordTypea Type indicating a cook book record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT cookbookRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCookbookSearchRecordTypes
Description

Gets the supported cook book search record types.

Returnosid.type.TypeLista list containing the supported cook book search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCookbookSearchRecordType
Description

Tests if the given cook book search record type is supported.

Parametersosid.type.TypecookbookSearchRecordTypea Type indicating a cook book record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT cookbookSearchRecordType is null
CompliancemandatoryThis method must be implemented.