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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

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.