Interface RecipeForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable
All Known Subinterfaces:
RecipeBatchForm
public interface RecipeForm extends OsidObjectForm, OsidSourceableForm

This is the form for creating and updating Recipes .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RecipeAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getTotalEstimatedDurationMetadata

      Metadata getTotalEstimatedDurationMetadata()
      Gets the metadata for the estimated duration. The duration may not be settable and derived from the estimated times of the directions.
      Returns:
      metadata for the estimated duration
      Compliance:
      mandatory - This method must be implemented.

    • setTotalEstimatedDuration

      void setTotalEstimatedDuration(Duration duration)
      Sets the estimated duration.
      Parameters:
      duration - the new estimated duration
      Throws:
      InvalidArgumentException - duration is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - duration is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTotalEstimatedDuration

      void clearTotalEstimatedDuration()
      Removes the estimated duration.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getAssetsMetadata

      Metadata getAssetsMetadata()
      Gets the metadata for the assets.
      Returns:
      metadata for the assets
      Compliance:
      mandatory - This method must be implemented.

    • setAssets

      void setAssets(Id[] assetIds)
      Sets the assets.
      Parameters:
      assetIds - the new assets
      Throws:
      InvalidArgumentException - assetIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - assetIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAssets

      void clearAssets()
      Removes the assets.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRecipeFormRecord

      RecipeFormRecord getRecipeFormRecord(Type recipeRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the RecipeFormRecord corresponding to the given recipe record Type .
      Parameters:
      recipeRecordType - a recipe record type
      Returns:
      the recipe form 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.