OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.Recipe
Implementsosid.OsidObject
osid.Sourceable
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.Durationthe estimated duration
CompliancemandatoryThis method must be implemented.
MethodgetAssetIds
Description

Gets any asset Ids for the goal of the recipe.

Returnosid.id.IdListthe asset Ids
CompliancemandatoryThis method must be implemented.
MethodgetAssets
Description

Gets any assets for the goal of the recipe.

Returnosid.repository.AssetListthe assets
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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.TyperecipeRecordTypethe type of recipe record to retrieve
Returnosid.recipe.records.RecipeRecordthe recipe record
ErrorsNULL_ARGUMENT recipeRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(recipeRecordType) is false
CompliancemandatoryThis method must be implemented.