Interface Obstacle

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidObject
public interface Obstacle extends OsidObject, Operable

A Obstacle represents a blockage along a Path .

  • Method Details

    • getPathId

      Id getPathId()
      Gets the path Id .
      Returns:
      the Id of the path
      Compliance:
      mandatory - This method must be implemented.

    • getPath

      Path getPath() throws OperationFailedException
      Gets the path.
      Returns:
      the path
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getStartingCoordinate

      Coordinate getStartingCoordinate()
      Gets the starting coordinate of the obstacle on the path.
      Returns:
      the start of the zone
      Compliance:
      mandatory - This method must be implemented.

    • getEndingCoordinate

      Coordinate getEndingCoordinate()
      Gets the ending coordinate of the obstacle on the path.
      Returns:
      the end of the zone
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleRecord

      ObstacleRecord getObstacleRecord(Type obstacleRecordType) throws OperationFailedException
      Gets the obstacle record corresponding to the given 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 .
      Parameters:
      obstacleRecordType - the type of obstacle record to retrieve
      Returns:
      the obstacle record
      Throws:
      NullArgumentException - obstacleRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(obstacleRecordType) is false
      Compliance:
      mandatory - This method must be implemented.