OSID - osid.mapping.path.Obstacle Service Interface Definition

Interface	osid.mapping.path.Obstacle
Implements	`osid.OsidObject`
Implements	`osid.Operable`
Used By	`osid.mapping.path.ObstacleAdminSession`
	`osid.mapping.path.ObstacleList`
	`osid.mapping.path.ObstacleLookupSession`
Description	A `Obstacle` represents a blockage along a `Path`.
Method	getPathId
Description	Gets the path `Id`.
Return	`osid.id.Id`		the `Id` of the path
Compliance	`mandatory`		This method must be implemented.
Method	getPath
Description	Gets the path.
Return	`osid.mapping.path.Path`		the path
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getStartingCoordinate
Description	Gets the starting coordinate of the obstacle on the path.
Return	`osid.mapping.Coordinate`		the start of the zone
Compliance	`mandatory`		This method must be implemented.
Method	getEndingCoordinate
Description	Gets the ending coordinate of the obstacle on the path.
Return	`osid.mapping.Coordinate`		the end of the zone
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleRecord
Description	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	`osid.type.Type`	`obstacleRecordType`	the type of obstacle record to retrieve
Return	`osid.mapping.path.records.ObstacleRecord`		the obstacle record
Errors	NULL_ARGUMENT		`obstacleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(obstacleRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.