OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.EdgeForm
Implementsosid.OsidRelationshipForm
Description

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.

MethodgetDirectionalMetadata
Description

Gets the metadata for a directional edges.

Returnosid.Metadatametadata for the directionality
CompliancemandatoryThis method must be implemented.
MethodsetDirectional
Description

Sets the directional flag.

Parametersbooleandirection true to set the edge as directional, false to set the edge as non-directional
ErrorsINVALID_ARGUMENT direction is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearDirectional
Description

Removes the directional flag.

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

Gets the metadata for an edge direction.

Returnosid.Metadatametadata for the direction
CompliancemandatoryThis method must be implemented.
MethodsetBiDirectional
Description

Sets the direction.

Parametersbooleandirection true to set the edge as bi-directional, false to set the edge as uni-directional
ErrorsINVALID_ARGUMENT direction is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearBiDirectional
Description

Removes the bi-directional flag.

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

Gets the metadata for an edge cost.

Returnosid.Metadatametadata for the cost
CompliancemandatoryThis method must be implemented.
MethodsetCost
Description

Sets the edge cost.

Parametersdecimalcostthe new cost
ErrorsINVALID_ARGUMENT cost is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearCost
Description

Removes the edge cost.

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

Gets the metadata for an edge distance.

Returnosid.Metadatametadata for the distance
CompliancemandatoryThis method must be implemented.
MethodsetDistance
Description

Sets the distance.

Parametersdecimaldistancethe new distance
ErrorsINVALID_ARGUMENT distance is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearDistance
Description

Removes the edge distance.

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

Gets the EdgeFormRecord corresponding to the given edge record Type.

Parametersosid.type.TypeedgeRecordTypea edge record type
Returnosid.topology.records.EdgeFormRecordthe edge form record
ErrorsNULL_ARGUMENT edgeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(edgeRecordType) is false
CompliancemandatoryThis method must be implemented.