OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.Recipe
Implementsosid.OsidObject
osid.Sourceable
Used Byosid.recipe.Direction
osid.recipe.RecipeAdminSession
osid.recipe.RecipeList
osid.recipe.RecipeLookupSession
Description

A Recipe. A Recipe is a set of Directions to do something.

MethodgetTotalEstimatedDuration
Description

Gets the overall time required for this recipe.

Returnosid.calendaring.Duration the estimated duration
Compliancemandatory This method must be implemented.
MethodgetAssetIds
Description

Gets any asset Ids for the goal of the recipe.

Returnosid.id.IdList the asset Ids
Compliancemandatory This method must be implemented.
MethodgetAssets
Description

Gets any assets for the goal of the recipe.

Returnosid.repository.AssetList the assets
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetRecipeRecord
Description

Gets the recipe record corresponding to the given Recipe record Type.This method is used to retrieve an object implementing the requested record. The recipeRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(recipeRecordType) is true.

Parametersosid.type.TyperecipeRecordType the type of recipe record to retrieve
Returnosid.recipe.records.RecipeRecord the recipe record
ErrorsNULL_ARGUMENT recipeRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(recipeRecordType) is false
Compliancemandatory This method must be implemented.