org.osid.recipe

Interface Direction

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable

public interface Direction
extends OsidObject, Subjugateable

A Direction is an instruction.

Method Summary

Methods

Modifier and Type	Method and Description
IdList	getAssetIds() Gets any asset Ids to assist in carrying out this direction.
AssetList	getAssets() Gets any assets to assist in carrying out this direction.
DirectionRecord	getDirectionRecord(Type directionRecordType) Gets the direction record corresponding to the given Direction record Type.
Duration	getEstimatedDuration() Gets the estimated time required for this direction.
IdList	getIngredientIds() Gets any ingredient Ids .
IngredientList	getIngredients() Gets the required ingredients.
IdList	getProcedureIds() Gets the Ids of the procedure to execute in this direction.
ProcedureList	getProcedures() Gets the procedures to execute in this direction.
Recipe	getRecipe() Gets the recipe.
Id	getRecipeId() Gets the Id of the recipe.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getRecipeId

Id getRecipeId()

Gets the Id of the recipe.

Returns:

the recipe Id

Compliance:

mandatory - This method must be implemented.

getRecipe

Recipe getRecipe()
                 throws OperationFailedException

Gets the recipe.

Returns:

the recipe

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getProcedureIds

IdList getProcedureIds()

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

Returns:

the procedure Ids

Compliance:

mandatory - This method must be implemented.

getProcedures

ProcedureList getProcedures()
                            throws OperationFailedException

Gets the procedures to execute in this direction.

Returns:

the procedures

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getIngredientIds

IdList getIngredientIds()

Gets any ingredient Ids .

Returns:

the ingredient Ids

Compliance:

mandatory - This method must be implemented.

getIngredients

IngredientList getIngredients()
                              throws OperationFailedException

Gets the required ingredients.

Returns:

the ingredients

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getEstimatedDuration

Duration getEstimatedDuration()

Gets the estimated time required for this direction.

Returns:

the estimated duration

Compliance:

mandatory - This method must be implemented.

getAssetIds

IdList getAssetIds()

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

Returns:

the asset Ids

Compliance:

mandatory - This method must be implemented.

getAssets

AssetList getAssets()
                    throws OperationFailedException

Gets any assets to assist in carrying out this direction.

Returns:

the assets

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getDirectionRecord

DirectionRecord getDirectionRecord(Type directionRecordType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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 .

Parameters:

directionRecordType - the type of direction record to retrieve

Returns:

the direction record

Throws:

NullArgumentException - directionRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(directionRecordType) is false

Compliance:

mandatory - This method must be implemented.