Package com.sentilant.telematicssdk

Class TelematicsServiceOptions

java.lang.Object
com.sentilant.telematicssdk.TelematicsServiceOptions
public class TelematicsServiceOptions extends Object
Represents configuration options for starting or stopping the telematics service.

This class encapsulates optional parameters such as the reason for starting/stopping, additional observations, vehicle-related data, and other service-specific information. It follows a fluent API design to allow chaining of setters.

  • Constructor Details

    • TelematicsServiceOptions

      public TelematicsServiceOptions()
      Creates an empty instance of TelematicsServiceOptions.

  • Method Details

    • setReason

      public TelematicsServiceOptions setReason(String reason)
      Sets the reason for starting or stopping the telematics service.
      Parameters:
      reason - the reason, used for logging or auditing; may be null or empty.
      Returns:
      this TelematicsServiceOptions instance for chaining.

    • setObservations

      public TelematicsServiceOptions setObservations(String observations)
      Sets additional observations or comments related to the operation.
      Parameters:
      observations - additional information; may be empty if not applicable.
      Returns:
      this TelematicsServiceOptions instance for chaining.

    • setRealVolume

      public TelematicsServiceOptions setRealVolume(Double realVolume)
      Sets the real volume value associated with the operation.
      Parameters:
      realVolume - the real volume (e.g., fuel, cargo) in appropriate units; may be null.
      Returns:
      this TelematicsServiceOptions instance for chaining.

    • setServiceCode

      public TelematicsServiceOptions setServiceCode(String serviceCode)
      Sets the service code used to identify the specific telematics service or operation.
      Parameters:
      serviceCode - the service code; may be null or empty.
      Returns:
      this TelematicsServiceOptions instance for chaining.

    • setVehicleKms

      public TelematicsServiceOptions setVehicleKms(Integer vehicleKms)
      Sets the current vehicle odometer reading in kilometers.
      Parameters:
      vehicleKms - the odometer value in kilometers; may be null.
      Returns:
      this TelematicsServiceOptions instance for chaining.

    • getReason

      public String getReason()
      Returns the reason for the operation.
      Returns:
      the reason, or null if not set.

    • getObservations

      public String getObservations()
      Returns any additional observations provided.
      Returns:
      the observations, or null if not set.

    • getRealVolume

      public Double getRealVolume()
      Returns the real volume value.
      Returns:
      the real volume, or null if not set.

    • getServiceCode

      public String getServiceCode()
      Returns the service code.
      Returns:
      the service code, or null if not set.

    • getVehicleKms

      public Integer getVehicleKms()
      Returns the vehicle odometer reading in kilometers.
      Returns:
      the odometer reading, or null if not set.