SectionNoticeCode (API Reference)
Enum Class SectionNoticeCode
- All Implemented Interfaces:
Serializable,Comparable<SectionNoticeCode>,Constable
Notice codes which point the issues encountered during processing of a Section.
Note: The section notice codes are going to be extended for new error situations.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionA charging stop was planned at the destination of this section, but it is no longer needed.Information about intermediate stops is not available for a transit section.No schedule information is available for a transit section.Route goes through a road that does not allow through traffic.Route utilizes a designated carpool lane, potentially subject to restrictions beyond the scheduled travel hours.Route includes a turn that is potentially restricted and inaccessible beyond the scheduled travel hours.Route utilizes roads that are potentially off-limits to the specified vehicle profile beyond the scheduled travel hours.Route incorporates roads within zones, which are potentially not accessible beyond the scheduled travel hours.This transit section returned times which are scheduled times, even though delay information is available.Route goes through seasonal closure.An accurate polyline is not available for this section.Route goes through toll booth that requires transponder.Tolls data was requested but is temporarily unavailable.Tolls data was requested but could not be calculated for this section.This transit section contains a transport mode that was explictly disabled.Route did not manage to avoid user preference.Route did not manage to avoid difficult turns.Route did not manage to avoid user preference.Route did not manage to avoid user preference.Route did not manage to avoid user preference.Route did not manage to avoid user preference.Route did not manage to avoid seasonal closure.Route did not manage to avoid user preference.Route did not manage to avoid toll booth that requires transponder.Route did not manage to avoid restricted truck road types.Route did not manage to avoid user preference.Route did not manage to avoid u turns.Route uses roads blocked by traffic events or route did not manage to avoid the requestedavoidBoundingBoxAreasorcountriesorsegments.Route did not manage to avoid user preference.Charging at the charging station planned at the destination of this section falls outside of opening hours.Route has violoated a non-detailed critical rule.Route goes through an emergency gate.The route can not reach all charging stations on the route with the minimum required charge, as the initial charge was to low.The route can not reach the waypoint, as the there are not enough charging stops available or the initial charge was to low.The route can not reach the first charging station with the minimum required charge, as the initial charge was to low.Start direction of the route is not as requested.Route uses a time-restricted turn.Route uses a road which is forbidden for the given vehicle profile.Route uses a road which is part of restrictedzoneCategoriesrequested to be avoided by user. -
Method Summary
Modifier and TypeMethodDescriptionstatic SectionNoticeCodeReturns the enum constant of this class with the specified name.static SectionNoticeCode[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
VIOLATED_CRITICAL_RULE
Route has violoated a non-detailed critical rule. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_CONTROLLED_ACCESS_HIGHWAY
Route did not manage to avoid user preference. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_TOLL_ROAD
Route did not manage to avoid user preference. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_FERRY
Route did not manage to avoid user preference. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_TUNNEL
Route did not manage to avoid user preference. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_DIRT_ROAD
Route did not manage to avoid user preference. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_RAIL_FERRY
Route did not manage to avoid user preference. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_PARK
Route did not manage to avoid user preference. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_BLOCKED_ROAD
Route uses roads blocked by traffic events or route did not manage to avoid the requested
avoidBoundingBoxAreasorcountriesorsegments. Severity:NoticeSeverity.CRITICAL. -
VIOLATED_START_DIRECTION
Start direction of the route is not as requested. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_CARPOOL
Route did not manage to avoid user preference. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_TURN_RESTRICTION
Route uses a time-restricted turn. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_VEHICLE_RESTRICTION
Route uses a road which is forbidden for the given vehicle profile. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_ZONE_RESTRICTION
Route uses a road which is part of restricted
zoneCategoriesrequested to be avoided by user. Severity:NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_U_TURNS
Route did not manage to avoid u turns. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_EMERGENCY_GATE
Route goes through an emergency gate. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_SEASONAL_CLOSURE
Route did not manage to avoid seasonal closure. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_TRUCK_ROAD_TYPE
Route did not manage to avoid restricted truck road types.
-
VIOLATED_AVOID_TOLL_TRANSPONDER
Route did not manage to avoid toll booth that requires transponder. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_CHARGING_STATION_OPENING_HOURS
Charging at the charging station planned at the destination of this section falls outside of opening hours. Severity:
NoticeSeverity.CRITICAL. -
VIOLATED_AVOID_DIFFICULT_TURNS
Route did not manage to avoid difficult turns. Severity:
NoticeSeverity.CRITICAL. -
SEASONAL_CLOSURE
Route goes through seasonal closure. Severity:
NoticeSeverity.INFO. -
TOLL_TRANSPONDER
Route goes through toll booth that requires transponder. Severity:
NoticeSeverity.INFO. -
TOLLS_DATA_UNAVAILABLE
Tolls data was requested but could not be calculated for this section. Severity:
NoticeSeverity.INFO. -
TOLLS_DATA_TEMPORARILY_UNAVAILABLE
Tolls data was requested but is temporarily unavailable. Severity:
NoticeSeverity.INFO. -
CHARGING_STOP_NOT_NEEDED
A charging stop was planned at the destination of this section, but it is no longer needed. It may be issued only when refreshing a route via
RouteHandle. Severity:NoticeSeverity.INFO. -
NO_SCHEDULE
No schedule information is available for a transit section. As a result, departure/arrival times are approximated. Severity:
NoticeSeverity.INFO. -
NO_INTERMEDIATE
Information about intermediate stops is not available for a transit section. Severity:
NoticeSeverity.INFO. -
UNWANTED_MODE
This transit section contains a transport mode that was explictly disabled. Mode filtering is not available in this area. Severity:
NoticeSeverity.INFO. -
SCHEDULED_TIMES
This transit section returned times which are scheduled times, even though delay information is available. Severity:
NoticeSeverity.INFO. -
SIMPLE_POLYLINE
An accurate polyline is not available for this section. An accurate polyline is not available for this section. The returned polyline has been generated from departure and arrival places. Severity:
NoticeSeverity.INFO. -
POTENTIAL_CARPOOL
Route utilizes a designated carpool lane, potentially subject to restrictions beyond the scheduled travel hours. Severity:
NoticeSeverity.INFO. -
POTENTIAL_TURN_RESTRICTION
Route includes a turn that is potentially restricted and inaccessible beyond the scheduled travel hours. Severity:
NoticeSeverity.INFO. -
POTENTIAL_VEHICLE_RESTRICTION
Route utilizes roads that are potentially off-limits to the specified vehicle profile beyond the scheduled travel hours. Severity:
NoticeSeverity.INFO. -
POTENTIAL_ZONE_RESTRICTION
Route incorporates roads within zones, which are potentially not accessible beyond the scheduled travel hours. Severity:
NoticeSeverity.INFO. -
VIOLATED_MIN_CHARGE_AT_FIRST_CS
The route can not reach the first charging station with the minimum required charge, as the initial charge was to low.
-
VIOLATED_MIN_CHARGE_AT_CS
The route can not reach all charging stations on the route with the minimum required charge, as the initial charge was to low.
-
VIOLATED_MIN_CHARGE_AT_DESTINATION
The route can not reach the waypoint, as the there are not enough charging stops available or the initial charge was to low.
-
NO_THROUGH_RESTRICTION
Route goes through a road that does not allow through traffic.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-