public interface Direction extends OsidObject, Subjugateable
A Direction
is an instruction.
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. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getRecipeId()
Id
of the recipe. Id
mandatory
- This method must be implemented. Recipe getRecipe() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getProcedureIds()
Ids
of the procedure to execute in this
direction. Ids
mandatory
- This method must be implemented. ProcedureList getProcedures() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getIngredientIds()
Ids
. Ids
mandatory
- This method must be implemented. IngredientList getIngredients() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Duration getEstimatedDuration()
mandatory
- This method must be implemented. IdList getAssetIds()
Ids
to assist in carrying out this
direction. Ids
mandatory
- This method must be implemented. AssetList getAssets() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DirectionRecord getDirectionRecord(Type directionRecordType) throws OperationFailedException, PermissionDeniedException
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
.directionRecordType
- the type of direction record to retrieveNullArgumentException
- directionRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(directionRecordType)
is false
mandatory
- This method must be implemented.