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

Interface	osid.mapping.path.SpeedZone
Implements	`osid.OsidRule`
Used By	`osid.mapping.path.SpeedZoneAdminSession`
	`osid.mapping.path.SpeedZoneList`
	`osid.mapping.path.SpeedZoneLookupSession`
Description	A `SpeedZone` represents a speed zone in a `Map`.
Method	getPathId
Description	Gets the path `Id` of this speed zone.
Return	`osid.id.Id`		the `Id` of the path
Compliance	`mandatory`		This method must be implemented.
Method	getPath
Description	Gets the path of this speed zone.
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 speed zone 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 speed zone on the path.
Return	`osid.mapping.Coordinate`		the end of the zone
Compliance	`mandatory`		This method must be implemented.
Method	isImplicit
Description	Tests if this speed zone is implicit. An implicit speed zone is generated from other information such as an `Obstacle`.
Return	`boolean`		`true` if this speed zone is implicit, `false` if explicitly managed
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedLimit
Description	Gets the speed limit in this zone.
Return	`osid.mapping.Speed`		the speed limit
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneRecord
Description	Gets the speed zone record corresponding to the given `SpeedZone` record `Type`. This method is used to retrieve an object implementing the requested record. The `speedZoneRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(speedZoneRecordType)` is `true`.
Parameters	`osid.type.Type`	`speedZoneRecordType`	the type of speed zone record to retrieve
Return	`osid.mapping.path.records.SpeedZoneRecord`		the speed zone record
Errors	NULL_ARGUMENT		`speedZoneRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(speedZoneRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.