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

Interface	osid.mapping.path.ResourceVelocity
Implements	`osid.OsidCompendium`
Description	A `Velocity` for a `Resource.`
Method	getResourceId
Description	Gets the `Resource` `Id.`
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getResource
Description	Gets the `Resource.`
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSpeed
Description	Gets the current speed.
Return	`osid.mapping.Speed`		the current speed
Compliance	`mandatory`		This method must be implemented.
Method	getPosition
Description	Gets the current position.
Return	`osid.mapping.Coordinate`		the current coordinate
Compliance	`mandatory`		This method must be implemented.
Method	getHeading
Description	Gets the current heading.
Return	`osid.mapping.Heading`		the current heading
Compliance	`mandatory`		This method must be implemented.
Method	isOnPath
Description	Tests if the resource is on a designated path.
Return	`boolean`		`true` if the resource is on a designated path, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPathId
Description	Gets the `Path` `Id.`
Return	`osid.id.Id`		the path `Id`
Errors	ILLEGAL_STATE		`isOnPath()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getPath
Description	Gets the `Path.`
Return	`osid.mapping.path.Path`		the path
Errors	ILLEGAL_STATE		`isOnPath()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getResourceVelocityRecord
Description	Gets the resource velocity record corresponding to the given `ResourceVelocity` record `Type.` This method is used to retrieve an object implementing the requested record. The `resourceVelocityRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(resourceVelocityRecordType)` is `true` .
Parameters	`osid.type.Type`	`resourceVelocityRecordType`	the type of resource velocity record to retrieve
Return	`osid.mapping.path.records.ResourceVelocityRecord`		the resource velocity record
Errors	NULL_ARGUMENT		`resourceVelocityRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(resourceVelocityRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.