org.osid.recipe

Interface DirectionForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

DirectionBatchForm

public interface DirectionForm
extends OsidObjectForm, OsidSubjugateableForm

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 Summary

Methods

Modifier and Type	Method and Description
void	clearAssets() Removes the assets.
void	clearEstimatedDuration() Removes the estimated duration.
void	clearProcedures() Removes the procedures.
Metadata	getAssetsMetadata() Gets the metadata for the assets.
DirectionFormRecord	getDirectionFormRecord(Type directionRecordType) Gets the DirectionFormRecord corresponding to the given direction record Type.
Metadata	getEstimatedDurationMetadata() Gets the metadata for the estimated duration.
Metadata	getProceduresMetadata() Gets the metadata for the procedures.
void	setAssets(Id[] assetIds) Sets the assets.
void	setEstimatedDuration(Duration duration) Sets the estimated duration.
void	setProcedures(Id[] procedureIds) Sets the procedures.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getProceduresMetadata

Metadata getProceduresMetadata()

Gets the metadata for the procedures.

Returns:

metadata for the procedures

Compliance:

mandatory - This method must be implemented.

setProcedures

void setProcedures(Id[] procedureIds)

Sets the procedures.

Parameters:

procedureIds - the new procedures

Throws:

InvalidArgumentException - procedureIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - procedureIds is null

Compliance:

mandatory - This method must be implemented.

clearProcedures

void clearProcedures()

Removes the procedures.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getEstimatedDurationMetadata

Metadata getEstimatedDurationMetadata()

Gets the metadata for the estimated duration.

Returns:

metadata for the estimated duration

Compliance:

mandatory - This method must be implemented.

setEstimatedDuration

void setEstimatedDuration(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.

clearEstimatedDuration

void clearEstimatedDuration()

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.

getDirectionFormRecord

DirectionFormRecord getDirectionFormRecord(Type directionRecordType)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets the DirectionFormRecord corresponding to the given direction record Type.

Parameters:

directionRecordType - a direction record type

Returns:

the direction form record

Throws:

NullArgumentException - directionRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(directionRecordType) is false

Compliance:

mandatory - This method must be implemented.