HERE Android SDK Developer's Guide

UMCalculateResult

The class UMCalculateResult is a member of com.here.android.mpa.routing .

Class Summary

public class UMCalculateResult

extends java.lang.Object

Represents result of Urban Mobility route calculation.

[For complete information, see the section Class Details]

Nested Class Summary

Table 1. Nested Classes in UMCalculateResult
Nested Classes

public static final enumeration UMCalculateResult.ViolatedOption

These are options which might not be taken into account when calculating the UMCalculateResult.

Method Summary

Table 2. Methods in UMCalculateResult
Methods

public java.util.Collection <Alert> getAlerts ()

Get alerts and disruptions associated with found connections.

public ErrorCode getError ()

Gets error code.

public String getErrorMessage ()

Gets error message string.

public java.util.Collection <Link> getOperatorDisclaimers ()

Gets collection of associated operator disclaimer Links.

public java.util.Collection <Operator> getOperators ()

Get the operators serving the found connections.

public java.util.List <UMRouteResult> getResults ()

Gets list of UMRouteResult.

public java.util.EnumSet <ViolatedOption> getViolatedOptions ()

Gets the violated options.

public boolean isSubsequentRouteSupported ()

Indicates if it's possible to calculate subsequent route for given result.

Class Details

Represents result of Urban Mobility route calculation.

Method Details

public java.util.Collection <Alert> getAlerts ()

Get alerts and disruptions associated with found connections.

Returns:

A Collection of Alerts.

public ErrorCode getError ()

Gets error code.

Returns:

A ErrorCode indicating the routing error.

public String getErrorMessage ()

Gets error message string.

Returns:

Error message, empty string or null.

public java.util.Collection <Link> getOperatorDisclaimers ()

Gets collection of associated operator disclaimer Links.

Returns:

collection of Links

public java.util.Collection <Operator> getOperators ()

Get the operators serving the found connections.

Returns:

A Collection of Operators.

public java.util.List <UMRouteResult> getResults ()

Gets list of UMRouteResult. In the case of VIOLATES_OPTIONS, one or more RouteResult in the returned list contains a list of violated RouteOptions.

Returns:

A List of UMRouteResult.

public java.util.EnumSet <ViolatedOption> getViolatedOptions ()

Gets the violated options.

Returns:

Set of UMCalculateResult.ViolatedOptions, or empty set if no options violated.

public boolean isSubsequentRouteSupported ()

Indicates if it's possible to calculate subsequent route for given result.

Returns:

True if result can be used to calculate subsequent routes, false otherwise.

See also:

{@link UMRouter#calculateSubsequentRoute(UMCalculateResult, UMRouter.SubsequentRouteType, int, Router.Listener)}.