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.
Modifier and Type | Method and Description |
---|---|
void |
clearAssets()
Removes the assets.
|
void |
clearTotalEstimatedDuration()
Removes the estimated duration.
|
Metadata |
getAssetsMetadata()
Gets the metadata for the assets.
|
RecipeFormRecord |
getRecipeFormRecord(Type recipeRecordType)
Gets the
RecipeFormRecord corresponding to the given
recipe record Type. |
Metadata |
getTotalEstimatedDurationMetadata()
Gets the metadata for the estimated duration.
|
void |
setAssets(Id[] assetIds)
Sets the assets.
|
void |
setTotalEstimatedDuration(Duration duration)
Sets the estimated duration.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider
Metadata getTotalEstimatedDurationMetadata()
mandatory
- This method must be implemented. void setTotalEstimatedDuration(Duration duration)
duration
- the new estimated durationInvalidArgumentException
- duration
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- duration
is
null
mandatory
- This method must be implemented. void clearTotalEstimatedDuration()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAssetsMetadata()
mandatory
- This method must be implemented. void setAssets(Id[] assetIds)
assetIds
- the new assetsInvalidArgumentException
- assetIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- assetIds
is
null
mandatory
- This method must be implemented. void clearAssets()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. RecipeFormRecord getRecipeFormRecord(Type recipeRecordType) throws OperationFailedException, PermissionDeniedException
RecipeFormRecord
corresponding to the given
recipe record Type.
recipeRecordType
- a recipe record typeNullArgumentException
- recipeRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(recipeRecordType)
is false
mandatory
- This method must be implemented.