Class RouteViolatedConstraints

    • Method Detail

      • allHazardsRestricted

        public final Boolean allHazardsRestricted()

        This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.

        Returns:
        This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.
      • axleCount

        public final RouteNoticeDetailRange axleCount()

        Total number of axles of the vehicle.

        Returns:
        Total number of axles of the vehicle.
      • hazardousCargos

        public final List<RouteHazardousCargoType> hazardousCargos()

        List of Hazardous cargo contained in the vehicle.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHazardousCargos() method.

        Returns:
        List of Hazardous cargo contained in the vehicle.
      • hasHazardousCargos

        public final boolean hasHazardousCargos()
        For responses, this returns true if the service returned a value for the HazardousCargos property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • hazardousCargosAsStrings

        public final List<String> hazardousCargosAsStrings()

        List of Hazardous cargo contained in the vehicle.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHazardousCargos() method.

        Returns:
        List of Hazardous cargo contained in the vehicle.
      • maxHeight

        public final Long maxHeight()

        The maximum height of the vehicle.

        Returns:
        The maximum height of the vehicle.
      • maxKpraLength

        public final Long maxKpraLength()

        The maximum Kpra length of the vehicle.

        Unit: centimeters

        Returns:
        The maximum Kpra length of the vehicle.

        Unit: centimeters

      • maxLength

        public final Long maxLength()

        The maximum length of the vehicle.

        Returns:
        The maximum length of the vehicle.
      • maxPayloadCapacity

        public final Long maxPayloadCapacity()

        The maximum load capacity of the vehicle.

        Unit: kilograms

        Returns:
        The maximum load capacity of the vehicle.

        Unit: kilograms

      • maxWeight

        public final RouteWeightConstraint maxWeight()

        The maximum weight of the route.

        Unit: Kilograms

        Returns:
        The maximum weight of the route.

        Unit: Kilograms

      • maxWeightPerAxle

        public final Long maxWeightPerAxle()

        The maximum weight per axle of the vehicle.

        Unit: Kilograms

        Returns:
        The maximum weight per axle of the vehicle.

        Unit: Kilograms

      • maxWeightPerAxleGroup

        public final WeightPerAxleGroup maxWeightPerAxleGroup()

        The maximum weight per axle group of the vehicle.

        Unit: Kilograms

        Returns:
        The maximum weight per axle group of the vehicle.

        Unit: Kilograms

      • maxWidth

        public final Long maxWidth()

        The maximum width of the vehicle.

        Returns:
        The maximum width of the vehicle.
      • occupancy

        public final RouteNoticeDetailRange occupancy()

        The number of occupants in the vehicle.

        Default Value: 1

        Returns:
        The number of occupants in the vehicle.

        Default Value: 1

      • restrictedTimes

        public final String restrictedTimes()

        Access radius restrictions based on time.

        Returns:
        Access radius restrictions based on time.
      • timeDependent

        public final Boolean timeDependent()

        The time dependent constraint.

        Returns:
        The time dependent constraint.
      • trailerCount

        public final RouteNoticeDetailRange trailerCount()

        Number of trailers attached to the vehicle.

        Default Value: 0

        Returns:
        Number of trailers attached to the vehicle.

        Default Value: 0

      • travelMode

        public final Boolean travelMode()

        Travel mode corresponding to the leg.

        Returns:
        Travel mode corresponding to the leg.
      • truckRoadType

        public final String truckRoadType()

        Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

        There are currently no other supported values as of 26th April 2024.

        Returns:
        Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

        There are currently no other supported values as of 26th April 2024.

      • tunnelRestrictionCode

        public final String tunnelRestrictionCode()

        The tunnel restriction code.

        Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

        • Tunnel Category B

          • Risk Level: Limited risk

          • Restrictions: Few restrictions

        • Tunnel Category C

          • Risk Level: Medium risk

          • Restrictions: Some restrictions

        • Tunnel Category D

          • Risk Level: High risk

          • Restrictions: Many restrictions occur

        • Tunnel Category E

          • Risk Level: Very high risk

          • Restrictions: Restricted tunnel

        Returns:
        The tunnel restriction code.

        Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

        • Tunnel Category B

          • Risk Level: Limited risk

          • Restrictions: Few restrictions

        • Tunnel Category C

          • Risk Level: Medium risk

          • Restrictions: Some restrictions

        • Tunnel Category D

          • Risk Level: High risk

          • Restrictions: Many restrictions occur

        • Tunnel Category E

          • Risk Level: Very high risk

          • Restrictions: Restricted tunnel

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)