Interface SpeedZoneForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable
All Known Subinterfaces:
SpeedZoneBatchForm
public interface SpeedZoneForm extends OsidRuleForm

This is the form for creating and updating SpeedZones. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the SpeedZoneAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getStartingCoordinateMetadata

      Metadata getStartingCoordinateMetadata()
      Gets the metadata for a starting coordinate.
      Returns:
      metadata for the starting coordinate
      Compliance:
      mandatory - This method must be implemented.

    • setStartingCoordinate

      void setStartingCoordinate(Coordinate coordinate)
      Sets the starting coordinate.
      Parameters:
      coordinate - the new starting coordinate
      Throws:
      InvalidArgumentException - coordinate is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - coordinate is null
      UnsupportedException - coordinate type is not supported
      Compliance:
      mandatory - This method must be implemented.

    • clearStartingCoordinate

      void clearStartingCoordinate()
      Removes the starting coordinate.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getEndingCoordinateMetadata

      Metadata getEndingCoordinateMetadata()
      Gets the metadata for a ending coordinate.
      Returns:
      metadata for the ending coordinate
      Compliance:
      mandatory - This method must be implemented.

    • setEndingCoordinate

      void setEndingCoordinate(Coordinate coordinate)
      Sets the ending coordinate.
      Parameters:
      coordinate - the new ending coordinate
      Throws:
      InvalidArgumentException - coordinate is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - coordinate is null
      UnsupportedException - coordinate type is not supported
      Compliance:
      mandatory - This method must be implemented.

    • clearEndingCoordinate

      void clearEndingCoordinate()
      Removes the ending coordinate.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedLimitMetadata

      Metadata getSpeedLimitMetadata()
      Gets the metadata for a speed limit.
      Returns:
      metadata for the speed limit
      Compliance:
      mandatory - This method must be implemented.

    • setSpeedLimit

      void setSpeedLimit(Speed speed)
      Sets the speed limit.
      Parameters:
      speed - the new speed limit
      Throws:
      InvalidArgumentException - speed is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - speed is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSpeedLimit

      void clearSpeedLimit()
      Removes the speed limit.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedZoneFormRecord

      SpeedZoneFormRecord getSpeedZoneFormRecord(Type speedZoneRecordType) throws OperationFailedException
      Gets the SpeedZoneFormRecord corresponding to the given speed zone record Type.
      Parameters:
      speedZoneRecordType - a speed zone record type
      Returns:
      the speed zone form record
      Throws:
      NullArgumentException - speedZoneRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(speedZoneRecordType) is false
      Compliance:
      mandatory - This method must be implemented.