OSID - osid.recipe.RecipeForm Service Interface Definition

Interface	osid.recipe.RecipeForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSourceableForm`
Implemented By	`osid.recipe.batch.RecipeBatchForm`
Used By	`osid.recipe.RecipeAdminSession`
Description	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	getTotalEstimatedDurationMetadata
Description	Gets the metadata for the estimated duration. The duration may not be settable and derived from the estimated times of the directions.
Return	`osid.Metadata`		metadata for the estimated duration
Compliance	`mandatory`		This method must be implemented.
Method	setTotalEstimatedDuration
Description	Sets the estimated duration.
Parameters	`osid.calendaring.Duration`	`duration`	the new estimated duration
Errors	INVALID_ARGUMENT		`duration` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`duration` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTotalEstimatedDuration
Description	Removes the estimated duration.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAssetsMetadata
Description	Gets the metadata for the assets.
Return	`osid.Metadata`		metadata for the assets
Compliance	`mandatory`		This method must be implemented.
Method	setAssets
Description	Sets the assets.
Parameters	`osid.id.Id[]`	`assetIds`	the new assets
Errors	INVALID_ARGUMENT		`assetIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`assetIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssets
Description	Removes the assets.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRecipeFormRecord
Description	Gets the `RecipeFormRecord` corresponding to the given recipe record `Type` .
Parameters	`osid.type.Type`	`recipeRecordType`	a recipe record type
Return	`osid.recipe.records.RecipeFormRecord`		the recipe form record
Errors	NULL_ARGUMENT		`recipeRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(recipeRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.