com.inrix.sdk

Class LocationsManager.GetLearnedLocationsOptions

java.lang.Object

com.inrix.sdk.LocationsManager.GetLearnedLocationsOptions

Enclosing class:

LocationsManager

public static final class LocationsManager.GetLearnedLocationsOptions
extends Object

Contains options to retrieve LearnedLocations.

Constructor Summary

Constructors

Constructor and Description
GetLearnedLocationsOptions() Initialize a new instance of LocationsManager.GetLearnedLocationsOptions class.
GetLearnedLocationsOptions(boolean excludeSavedLocations, boolean includeHiddenLocations) Initialize a new instance of LocationsManager.GetLearnedLocationsOptions class.

Method Summary

Methods

Modifier and Type	Method and Description
void	setExcludeSavedLocations(boolean value) Set the property indicating whether learned locations which have been saved should be included in the result.
void	setIncludeHiddenLocations(boolean value) Set the property indicating whether hidden LearnedLocations should be included in the result.
void	setLocale(Locale locale) Set the locale of the LearnedLocations.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GetLearnedLocationsOptions

public GetLearnedLocationsOptions()

Initialize a new instance of LocationsManager.GetLearnedLocationsOptions class.

GetLearnedLocationsOptions

public GetLearnedLocationsOptions(boolean excludeSavedLocations,
                          boolean includeHiddenLocations)

Initialize a new instance of LocationsManager.GetLearnedLocationsOptions class.

Parameters:

excludeSavedLocations - true if saved locations should be excluded, false otherwise.

includeHiddenLocations - true if hidden locations should be included, false otherwise.

Method Detail

setExcludeSavedLocations

public void setExcludeSavedLocations(boolean value)

Set the property indicating whether learned locations which have been saved should be included in the result. Default value is true.

Parameters:

value - true if saved locations should be excluded, false otherwise.

setIncludeHiddenLocations

public void setIncludeHiddenLocations(boolean value)

Set the property indicating whether hidden LearnedLocations should be included in the result. Default value is false.

Parameters:

value - true if hidden locations should be included, false otherwise.

setLocale

public void setLocale(Locale locale)

Set the locale of the LearnedLocations.

Parameters:

locale - The locale or null to use the default.

toString

public String toString()

Overrides:

toString in class Object