Interface | osid.topology.EdgeForm | ||
---|---|---|---|
Implements | osid.OsidRelationshipForm | ||
Description |
This is the form for creating and updating | ||
Method | getDirectionalMetadata | ||
Description |
Gets the metadata for a directional edges. | ||
Return | osid.Metadata | metadata for the directionality | |
Compliance | mandatory | This method must be implemented. | |
Method | setDirectional | ||
Description |
Sets the directional flag. | ||
Parameters | boolean | direction | true to set the edge as directional, false to
set the edge as non-directional |
Errors | INVALID_ARGUMENT | direction is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDirectional | ||
Description |
Removes the directional flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getBiDirectionalMetadata | ||
Description |
Gets the metadata for an edge direction. | ||
Return | osid.Metadata | metadata for the direction | |
Compliance | mandatory | This method must be implemented. | |
Method | setBiDirectional | ||
Description |
Sets the direction. | ||
Parameters | boolean | direction | true to set the edge as bi-directional, false
to set the edge as uni-directional |
Errors | INVALID_ARGUMENT | direction is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearBiDirectional | ||
Description |
Removes the bi-directional flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getCostMetadata | ||
Description |
Gets the metadata for an edge cost. | ||
Return | osid.Metadata | metadata for the cost | |
Compliance | mandatory | This method must be implemented. | |
Method | setCost | ||
Description |
Sets the edge cost. | ||
Parameters | decimal | cost | the new cost |
Errors | INVALID_ARGUMENT | cost is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCost | ||
Description |
Removes the edge cost. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistanceMetadata | ||
Description |
Gets the metadata for an edge distance. | ||
Return | osid.Metadata | metadata for the distance | |
Compliance | mandatory | This method must be implemented. | |
Method | setDistance | ||
Description |
Sets the distance. | ||
Parameters | decimal | distance | the new distance |
Errors | INVALID_ARGUMENT | distance is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDistance | ||
Description |
Removes the edge distance. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | edgeRecordType | a edge record type |
Return | osid.topology.records.EdgeFormRecord | the edge form record | |
Errors | NULL_ARGUMENT | edgeRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(edgeRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |