public interface ResourceVelocity extends OsidCompendium
A Velocity
for a Resource.
Modifier and Type | Method and Description |
---|---|
Heading |
getHeading()
Gets the current heading.
|
Path |
getPath()
Gets the
Path. |
Id |
getPathId()
Gets the
Path Id. |
Coordinate |
getPosition()
Gets the current position.
|
Resource |
getResource()
Gets the
Resource. |
Id |
getResourceId()
Gets the
Resource Id. |
ResourceVelocityRecord |
getResourceVelocityRecord(Type resourceVelocityRecordType)
Gets the resource velocity record corresponding to the given
ResourceVelocity record Type. |
Speed |
getSpeed()
Gets the current speed.
|
boolean |
isOnPath()
Tests if the resource is on a designated path.
|
getEndDate, getStartDate, isExtrapolated, isInterpolated
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getResourceId()
Resource
Id.
Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
Resource.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Speed getSpeed()
mandatory
- This method must be implemented. Coordinate getPosition()
mandatory
- This method must be implemented. Heading getHeading()
mandatory
- This method must be implemented. boolean isOnPath()
true
if the resource is on a designated path,
false
otherwisemandatory
- This method must be implemented. Id getPathId()
Path
Id.
Id
IllegalStateException
- isOnPath()
is
false
mandatory
- This method must be implemented. Path getPath() throws OperationFailedException
Path.
IllegalStateException
- isOnPath()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ResourceVelocityRecord getResourceVelocityRecord(Type resourceVelocityRecordType) throws OperationFailedException
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
.resourceVelocityRecordType
- the type of resource velocity
record to retrieveNullArgumentException
-
resourceVelocityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(resourceVelocityRecordType)
is
false
mandatory
- This method must be implemented.