OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.Direction
Implementsosid.OsidObject
osid.Subjugateable
Used Byosid.recipe.DirectionAdminSession
osid.recipe.DirectionList
osid.recipe.DirectionLookupSession
Description

A Direction is an instruction.

MethodgetRecipeId
Description

Gets the Id of the recipe.

Returnosid.id.Id the recipe Id
Compliancemandatory This method must be implemented.
MethodgetRecipe
Description

Gets the recipe.

Returnosid.recipe.Recipe the recipe
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetProcedureIds
Description

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

Returnosid.id.IdList the procedure Ids
Compliancemandatory This method must be implemented.
MethodgetProcedures
Description

Gets the procedures to execute in this direction.

Returnosid.recipe.ProcedureList the procedures
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetIngredientIds
Description

Gets any ingredient Ids.

Returnosid.id.IdList the ingredient Ids
Compliancemandatory This method must be implemented.
MethodgetIngredients
Description

Gets the required ingredients.

Returnosid.recipe.IngredientList the ingredients
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetEstimatedDuration
Description

Gets the estimated time required for this direction.

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

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

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

Gets any assets to assist in carrying out this direction.

Returnosid.repository.AssetList the assets
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This 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.TypedirectionRecordType the type of direction record to retrieve
Returnosid.recipe.records.DirectionRecord the direction record
ErrorsNULL_ARGUMENT directionRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(directionRecordType) is false
Compliancemandatory This method must be implemented.