OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.RecipeForm
Implementsosid.OsidObjectForm
osid.OsidSourceableForm
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.

MethodgetTotalEstimatedDurationMetadata
Description

Gets the metadata for the estimated duration. The duration may not be settable and derived from the estimated times of the directions.

Returnosid.Metadatametadata for the estimated duration
CompliancemandatoryThis method must be implemented.
MethodsetTotalEstimatedDuration
Description

Sets the estimated duration.

Parametersosid.calendaring.Durationdurationthe new estimated duration
ErrorsINVALID_ARGUMENT duration is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT duration is null
CompliancemandatoryThis method must be implemented.
MethodclearTotalEstimatedDuration
Description

Removes the estimated duration.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetAssetsMetadata
Description

Gets the metadata for the assets.

Returnosid.Metadatametadata for the assets
CompliancemandatoryThis method must be implemented.
MethodsetAssets
Description

Sets the assets.

Parametersosid.id.Id[]assetIdsthe new assets
ErrorsINVALID_ARGUMENT assetIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT assetIds is null
CompliancemandatoryThis method must be implemented.
MethodclearAssets
Description

Removes the assets.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRecipeFormRecord
Description

Gets the RecipeFormRecord corresponding to the given recipe record Type.

Parametersosid.type.TyperecipeRecordTypea recipe record type
Returnosid.recipe.records.RecipeFormRecordthe recipe form record
ErrorsNULL_ARGUMENT recipeRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(recipeRecordType) is false
CompliancemandatoryThis method must be implemented.