OSID - osid.recipe.DirectionForm Service Interface Definition

Interface	osid.recipe.DirectionForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.recipe.batch.DirectionBatchForm`
Used By	`osid.recipe.DirectionAdminSession`
Description	This is the form for creating and updating `Directions`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `DirectionAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getProceduresMetadata
Description	Gets the metadata for the procedures.
Return	`osid.Metadata`		metadata for the procedures
Compliance	`mandatory`		This method must be implemented.
Method	setProcedures
Description	Sets the procedures.
Parameters	`osid.id.Id[]`	`procedureIds`	the new procedures
Errors	INVALID_ARGUMENT		`procedureIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`procedureIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProcedures
Description	Removes the procedures.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEstimatedDurationMetadata
Description	Gets the metadata for the estimated duration.
Return	`osid.Metadata`		metadata for the estimated duration
Compliance	`mandatory`		This method must be implemented.
Method	setEstimatedDuration
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	clearEstimatedDuration
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	getDirectionFormRecord
Description	Gets the `DirectionFormRecord` corresponding to the given direction record `Type`.
Parameters	`osid.type.Type`	`directionRecordType`	a direction record type
Return	`osid.recipe.records.DirectionFormRecord`		the direction form record
Errors	NULL_ARGUMENT		`directionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(directionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.