com.inrix.sdk

Class ItineraryManager.GetItineraryOptions

java.lang.Object

com.inrix.sdk.ItineraryManager.GetItineraryOptions

Enclosing class:

ItineraryManager

public static final class ItineraryManager.GetItineraryOptions
extends Object

Contains options to get a user's itinerary.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RANGE_DAYS Maximum allowed date range (in days).

Constructor Summary

Constructors

Constructor and Description
GetItineraryOptions(Date startDate, Date endDate) Initializes a new instance of ItineraryManager.GetItineraryOptions.

Method Summary

Methods

Modifier and Type	Method and Description
void	setDateRange(Date startDate, Date endDate) Specify the date range of the desired Itinerary.
void	setIncludeHiddenTrips(boolean value) Set the property indicating whether hidden LearnedTrips should be included in the result.
void	setLocale(Locale locale) Set the locale of the Itinerary.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_RANGE_DAYS

public static final int MAX_RANGE_DAYS

Maximum allowed date range (in days).

See Also:

Constant Field Values

Constructor Detail

GetItineraryOptions

public GetItineraryOptions(Date startDate,
                   Date endDate)

Initializes a new instance of ItineraryManager.GetItineraryOptions. The endDate must be past the startDate and the range must not exceed ItineraryManager.GetItineraryOptions.MAX_RANGE_DAYS days.

Parameters:

startDate - Start date/time of the itinerary (UTC).

endDate - End date/time of the itinerary (UTC).

Throws:

ItineraryManager.ItineraryManagerException - Thrown when startDate or endDate is invalid.

Method Detail

setDateRange

public void setDateRange(Date startDate,
                Date endDate)

Specify the date range of the desired Itinerary.

The Date is expected to be in UTC timezone.

Parameters:

startDate - Start date/time of the itinerary (UTC).

endDate - End date/time of the itinerary (UTC).

setIncludeHiddenTrips

public void setIncludeHiddenTrips(boolean value)

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

Parameters:

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

setLocale

public void setLocale(Locale locale)

Set the locale of the Itinerary.

Parameters:

locale - The locale or null to use the default.

toString

public String toString()

Overrides:

toString in class Object