OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.Direction
Implementsosid.OsidObject
osid.Subjugateable
Description

A Direction is an instruction.

MethodgetRecipeId
Description

Gets the Id of the recipe.

Returnosid.id.Idthe recipe Id
CompliancemandatoryThis method must be implemented.
MethodgetRecipe
Description

Gets the recipe.

Returnosid.recipe.Recipethe recipe
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetProcedureIds
Description

Gets the Ids of the procedure to execute in this direction.

Returnosid.id.IdListthe procedure Ids
CompliancemandatoryThis method must be implemented.
MethodgetProcedures
Description

Gets the procedures to execute in this direction.

Returnosid.recipe.ProcedureListthe procedures
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetIngredientIds
Description

Gets any ingredient Ids .

Returnosid.id.IdListthe ingredient Ids
CompliancemandatoryThis method must be implemented.
MethodgetIngredients
Description

Gets the required ingredients.

Returnosid.recipe.IngredientListthe ingredients
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetEstimatedDuration
Description

Gets the estimated time required for this direction.

Returnosid.calendaring.Durationthe estimated duration
CompliancemandatoryThis method must be implemented.
MethodgetAssetIds
Description

Gets any asset Ids to assist in carrying out this direction.

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

Gets any assets to assist in carrying out this direction.

Returnosid.repository.AssetListthe assets
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDirectionRecord
Description

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

Parametersosid.type.TypedirectionRecordTypethe type of direction record to retrieve
Returnosid.recipe.records.DirectionRecordthe direction record
ErrorsNULL_ARGUMENT directionRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(directionRecordType) is false
CompliancemandatoryThis method must be implemented.