public interface Obstacle extends OsidObject, Operable
A Obstacle
represents a blockage along a Path.
Modifier and Type | Method and Description |
---|---|
Coordinate |
getEndingCoordinate()
Gets the ending coordinate of the obstacle on the path.
|
ObstacleRecord |
getObstacleRecord(Type obstacleRecordType)
Gets the obstacle record corresponding to the given
Obstacle
record Type. |
Path |
getPath()
Gets the path.
|
Id |
getPathId()
Gets the path
Id. |
Coordinate |
getStartingCoordinate()
Gets the starting coordinate of the obstacle on the path.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
Id getPathId()
Id.
Id
of the pathmandatory
- This method must be implemented. Path getPath() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Coordinate getStartingCoordinate()
mandatory
- This method must be implemented. Coordinate getEndingCoordinate()
mandatory
- This method must be implemented. ObstacleRecord getObstacleRecord(Type obstacleRecordType) throws OperationFailedException
Obstacle
record Type.
This method is used to retrieve an
object implementing the requested record. The
obstacleRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(obstacleRecordType)
is true
.obstacleRecordType
- the type of obstacle record to retrieveNullArgumentException
- obstacleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(obstacleRecordType)
is false
mandatory
- This method must be implemented.