Interface Recipe

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Sourceable
public interface Recipe extends OsidObject, Sourceable

A Recipe . A Recipe is a set of Directions to do something.

  • Method Details

    • getTotalEstimatedDuration

      Duration getTotalEstimatedDuration()
      Gets the overall time required for this recipe.
      Returns:
      the estimated duration
      Compliance:
      mandatory - This method must be implemented.

    • getAssetIds

      IdList getAssetIds()
      Gets any asset Ids for the goal of the recipe.
      Returns:
      the asset Ids
      Compliance:
      mandatory - This method must be implemented.

    • getAssets

      AssetList getAssets() throws OperationFailedException
      Gets any assets for the goal of the recipe.
      Returns:
      the assets
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRecipeRecord

      RecipeRecord getRecipeRecord(Type recipeRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the recipe record corresponding to the given 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 .
      Parameters:
      recipeRecordType - the type of recipe record to retrieve
      Returns:
      the recipe record
      Throws:
      NullArgumentException - recipeRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - hasRecordType(recipeRecordType) is false
      Compliance:
      mandatory - This method must be implemented.