OSID - osid.recipe.RecipeProfile Service Interface Definition

Interface	osid.recipe.RecipeProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.recipe.RecipeManager`
Implemented By	`osid.recipe.RecipeProxyManager`
Description	The recipe profile describes the interoperability among recipe services.
Method	supportsVisibleFederation
Description	Tests if any cookbook federation is exposed. Federation is exposed when a specific cookbook may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of cookbooks 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 cookbook lookup service is supported.
Return	`boolean`		`true` if a recipe cookbook lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRecipeCookbookAssignment
Description	Tests if a recipe cookbook service is supported.
Return	`boolean`		`true` if recipe to cookbook assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRecipeSmartCookbook
Description	Tests if a recipe smart cookbook lookup service is supported.
Return	`boolean`		`true` if a recipe smart cookbook 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 administrative service is supported.
Return	`boolean`		`true` if direction administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDirectionNotification
Description	Tests if a direction notification service is supported.
Return	`boolean`		`true` if direction notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDirectionCookbook
Description	Tests if a direction cookbook lookup service is supported.
Return	`boolean`		`true` if a direction cookbook lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDirectionCookbookAssignment
Description	Tests if a direction cookbook assignment service is supported.
Return	`boolean`		`true` if a direction to cookbook assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDirectionSmartCookbook
Description	Tests if a direction smart cookbook service is supported.
Return	`boolean`		`true` if a direction smart cookbook 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 cookbook lookup session is available.
Return	`boolean`		`true` if procedure cookbook lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcedureCookbookAssignment
Description	Tests if a procedure to cookbook assignment session is available.
Return	`boolean`		`true` if procedure cookbook assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcedureSmartCookbook
Description	Tests if a procedure smart cookbook session is available.
Return	`boolean`		`true` if procedure smart cookbook is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCookbookLookup
Description	Tests for the availability of a cookbook lookup service.
Return	`boolean`		`true` if cookbook lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCookbookQuery
Description	Tests if querying cookbooks is available.
Return	`boolean`		`true` if cookbook query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCookbookSearch
Description	Tests if searching for cookbooks is available.
Return	`boolean`		`true` if cookbook search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCookbookAdmin
Description	Tests for the availability of a cookbook administrative service for creating and deleting cookbooks.
Return	`boolean`		`true` if cookbook administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCookbookNotification
Description	Tests for the availability of a cookbook notification service.
Return	`boolean`		`true` if cookbook notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsCookbookHierarchy
Description	Tests for the availability of a cookbook hierarchy traversal service.
Return	`boolean`		`true` if cookbook hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCookbookHierarchyDesign
Description	Tests for the availability of a cookbook hierarchy design service.
Return	`boolean`		`true` if cookbook hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsRecipeBatch
Description	Tests for the availability of a batch recipe service.
Return	`boolean`		`true` if a batch recipe service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	getRecipeRecordTypes
Description	Gets the supported `Recipe` record types.
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 `Recipe` record type is supported.
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 `Recipe` search record types.
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 `Recipe` search record type is supported.
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 `Direction` record types.
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 `Direction` record type is supported.
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 `Direction` search types.
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 `Direction` search type is supported.
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 `Ingredient` record types.
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 `Ingredient` record type is supported.
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 `Procedure` record types.
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 `Procedure` record type is supported.
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 cookbook record types.
Return	`osid.type.TypeList`		a list containing the supported cookbook record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCookbookRecordType
Description	Tests if the given cookbook record type is supported.
Parameters	`osid.type.Type`	`cookbookRecordType`	a `Type` indicating a cookbook 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 cookbook search record types.
Return	`osid.type.TypeList`		a list containing the supported cookbook search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCookbookSearchRecordType
Description	Tests if the given cookbook search record type is supported.
Parameters	`osid.type.Type`	`cookbookSearchRecordType`	a `Type` indicating a cookbook 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.