Interface ResourceVelocity

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidCompendium, OsidObject, Subjugateable
public interface ResourceVelocity extends OsidCompendium

A Velocity for a Resource.

  • Method Details

    • getResourceId

      Id getResourceId()
      Gets the Resource Id.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getResource

      Resource getResource() throws OperationFailedException
      Gets the Resource.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSpeed

      Speed getSpeed()
      Gets the current speed.
      Returns:
      the current speed
      Compliance:
      mandatory - This method must be implemented.

    • getPosition

      Coordinate getPosition()
      Gets the current position.
      Returns:
      the current coordinate
      Compliance:
      mandatory - This method must be implemented.

    • getHeading

      Heading getHeading()
      Gets the current heading.
      Returns:
      the current heading
      Compliance:
      mandatory - This method must be implemented.

    • isOnPath

      boolean isOnPath()
      Tests if the resource is on a designated path.
      Returns:
      true if the resource is on a designated path, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPathId

      Id getPathId()
      Gets the Path Id.
      Returns:
      the path Id
      Throws:
      IllegalStateException - isOnPath() is false
      Compliance:
      mandatory - This method must be implemented.

    • getPath

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

    • getResourceVelocityRecord

      ResourceVelocityRecord getResourceVelocityRecord(Type resourceVelocityRecordType) throws OperationFailedException
      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:
      resourceVelocityRecordType - the type of resource velocity record to retrieve
      Returns:
      the resource velocity record
      Throws:
      NullArgumentException - resourceVelocityRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(resourceVelocityRecordType) is false
      Compliance:
      mandatory - This method must be implemented.