public interface Recipe extends OsidObject, Sourceable
A Recipe
. A Recipe
is a set of
Directions
to do something.
Modifier and Type | Method and Description |
---|---|
IdList |
getAssetIds()
Gets any asset
Ids for the goal of the recipe. |
AssetList |
getAssets()
Gets any assets for the goal of the recipe.
|
RecipeRecord |
getRecipeRecord(Type recipeRecordType)
Gets the recipe record corresponding to the given
Recipe
record Type. |
Duration |
getTotalEstimatedDuration()
Gets the overall time required for this recipe.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
Duration getTotalEstimatedDuration()
mandatory
- This method must be implemented. IdList getAssetIds()
Ids
for the goal of the recipe. Ids
mandatory
- This method must be implemented. AssetList getAssets() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. RecipeRecord getRecipeRecord(Type recipeRecordType) throws OperationFailedException, PermissionDeniedException
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
.recipeRecordType
- the type of recipe record to retrieveNullArgumentException
- recipeRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(recipeRecordType)
is false
mandatory
- This method must be implemented.