| Interface | osid.mapping.path.Intersection | ||
|---|---|---|---|
| Implements | osid.OsidObject | ||
osid.Aggregateable | |||
| Description |
An intersection represents a crossing of paths where one can travel from one path to another. | ||
| Method | getCoordinate | ||
| Description |
Gets a single corrdinate to represent the intersection. | ||
| Return | osid.mapping.Coordinate | the coordinate | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathIds | ||
| Description |
Gets the intersecting path | ||
| Return | osid.id.IdList | the path Ids | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPaths | ||
| Description |
Gets the intersecting paths. | ||
| Return | osid.mapping.path.PathList | the paths | |
| Errors | OPERATION_FAILED | unable to complete request | |
| Compliance | mandatory | This method must be implemented. | |
| Method | isRotary | ||
| Description |
Tests if this intersection is a rotary. | ||
| Return | boolean | true if this intersection is a rotary, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | isFork | ||
| Description |
Tests if this intersection is a fork or exit. | ||
| Return | boolean | true if this intersection is a fork, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIntersectionRecord | ||
| Description |
Gets the intersection record corresponding to the given
| ||
| Parameters | osid.type.Type | intersectionRecordType | the type of intersection record to retrieve |
| Return | osid.mapping.path.records.IntersectionRecord | the intersection record | |
| Errors | NULL_ARGUMENT | intersectionRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(intersectionRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |