ViolatedRestriction (API Reference)
Class ViolatedRestriction
ViolatedRestriction contains all the violated restriction details for the planned trip.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classOptional restriction details, contains additional information depending on the specific violation, zero or more member might be set. -
Field Summary
FieldsModifier and TypeFieldDescriptionCause of the notice.The detailed information of restriction depending on the specific violation.booleanIndicates that restriction depends on time. -
Constructor Summary
ConstructorsConstructorDescriptionViolatedRestriction(String cause, boolean timeDependent) Creates a new instance. -
Method Summary
-
Field Details
-
cause
Cause of the notice. Human readable description of the notice, for example "Route violates vehicle restriction". It will be EN-US text only.
-
timeDependent
public boolean timeDependentIndicates that restriction depends on time.
-
details
The detailed information of restriction depending on the specific violation. For time dependent restriction or transport mode restriction, this property will be null. For vehicle restriction, the corresponding member will be set, for example, if the vehicle violates the maximum allowed gross weight for a specific route, the max_gross_weight_in_kilograms will be set with the maximum allowed gross weight for this route.
-
-
Constructor Details
-
ViolatedRestriction
Creates a new instance.
- Parameters:
cause-Cause of the notice. Human readable description of the notice, for example "Route violates vehicle restriction". It will be EN-US text only.
timeDependent-Indicates that restriction depends on time.
-
-
Method Details