org.osid.topology

Interface EdgeForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

EdgeBatchForm

public interface EdgeForm
extends OsidRelationshipForm

This is the form for creating and updating Edges. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the EdgeAdminSession. 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	clearBiDirectional() Removes the bi-directional flag.
void	clearCost() Removes the edge cost.
void	clearDirectional() Removes the directional flag.
void	clearDistance() Removes the edge distance.
Metadata	getBiDirectionalMetadata() Gets the metadata for an edge direction.
Metadata	getCostMetadata() Gets the metadata for an edge cost.
Metadata	getDirectionalMetadata() Gets the metadata for a directional edges.
Metadata	getDistanceMetadata() Gets the metadata for an edge distance.
EdgeFormRecord	getEdgeFormRecord(Type edgeRecordType) Gets the EdgeFormRecord corresponding to the given edge record Type.
void	setBiDirectional(boolean direction) Sets the direction.
void	setCost(java.math.BigDecimal cost) Sets the edge cost.
void	setDirectional(boolean direction) Sets the directional flag.
void	setDistance(java.math.BigDecimal distance) Sets the distance.

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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getDirectionalMetadata

Metadata getDirectionalMetadata()

Gets the metadata for a directional edges.

Returns:

metadata for the directionality

Compliance:

mandatory - This method must be implemented.

setDirectional

void setDirectional(boolean direction)

Sets the directional flag.

Parameters:

direction - true to set the edge as directional, false to set the edge as non-directional

Throws:

InvalidArgumentException - direction is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearDirectional

void clearDirectional()

Removes the directional flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getBiDirectionalMetadata

Metadata getBiDirectionalMetadata()

Gets the metadata for an edge direction.

Returns:

metadata for the direction

Compliance:

mandatory - This method must be implemented.

setBiDirectional

void setBiDirectional(boolean direction)

Sets the direction.

Parameters:

direction - true to set the edge as bi-directional, false to set the edge as uni-directional

Throws:

InvalidArgumentException - direction is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearBiDirectional

void clearBiDirectional()

Removes the bi-directional flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCostMetadata

Metadata getCostMetadata()

Gets the metadata for an edge cost.

Returns:

metadata for the cost

Compliance:

mandatory - This method must be implemented.

setCost

void setCost(java.math.BigDecimal cost)

Sets the edge cost.

Parameters:

cost - the new cost

Throws:

InvalidArgumentException - cost is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearCost

void clearCost()

Removes the edge cost.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getDistanceMetadata

Metadata getDistanceMetadata()

Gets the metadata for an edge distance.

Returns:

metadata for the distance

Compliance:

mandatory - This method must be implemented.

setDistance

void setDistance(java.math.BigDecimal distance)

Sets the distance.

Parameters:

distance - the new distance

Throws:

InvalidArgumentException - distance is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearDistance

void clearDistance()

Removes the edge distance.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getEdgeFormRecord

EdgeFormRecord getEdgeFormRecord(Type edgeRecordType)
                                 throws OperationFailedException

Gets the EdgeFormRecord corresponding to the given edge record Type.

Parameters:

edgeRecordType - a edge record type

Returns:

the edge form record

Throws:

NullArgumentException - edgeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(edgeRecordType) is false

Compliance:

mandatory - This method must be implemented.