ItineraryEntry (INRIX Mobile Client SDK

java.lang.Object
- com.inrix.sdk.model.ItineraryEntry

```
public final class ItineraryEntry
extends Object
```
An ItineraryEntry represents a single instance of a Trip on a user's Itinerary. These entries can be populated with any type of Trip including:
For recurring Trips, there will be one ItineraryEntry for each instance of the Trip during the Itinerary period.
An ItineraryEntry contains a basic set of details about the Trip, for full details about the trip use ItineraryEntry.getTripType() and ItineraryEntry.getTrip().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ItineraryEntry.TripType
TripType indicates the source of the ItineraryEntry.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ItineraryEntry.TripType` `TripType` indicates the source of the `ItineraryEntry`.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_TRAVEL_TIME_MIN
Default travel time (in minutes) when travel time cannot be determined.

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_TRAVEL_TIME_MIN` Default travel time (in minutes) when travel time cannot be determined.

Method Summary

Methods
Modifier and Type	Method and Description
`Date`	`getApproximateArrivalTime()` Gets the approximate arrival time based on the uncongested travel time.
`List<Trip>`	`getAssociatedTrips()` Get the `List` of `Trip`s which are associated with this `ItineraryEntry`.
`Date`	`getDateTime()` The date/time of this `Trip` instance (UTC).
`TripPoint`	`getDestination()` Get the final destination of the `Trip`.
`Integer`	`getNotificationTime()` Get the time (in minutes) before the scheduled departure time to notify the user.
`TripPoint`	`getOrigin()` Get the origin of the `Trip`.
`Schedule.ScheduleType`	`getScheduleType()` Get the type of schedule for the `ItineraryEntry`.
`Date`	`getSuggestedDepartureTime()` Gets the suggested departure time based on the uncongested travel time.
`Double`	`getTravelTime()` Gets the uncongested travel time (in minutes) from the given origin to the destination.
`Trip`	`getTrip()` The `Trip` this `ItineraryEntry` was created from.
`ItineraryEntry.TripType`	`getTripType()` Get the type of `Trip` which this `ItineraryEntry` was created from.
`List<TripPoint>`	`getWaypoints()` Get the ordered list of waypoints along the `Trip`.
`boolean`	`isFuelRequired()` Get the fuel status for this `ItineraryEntry`.
`boolean`	`isNotificationEnabled()` Indicates whether notifications are enabled for this `ItineraryEntry`.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_TRAVEL_TIME_MIN
```
public static final int DEFAULT_TRAVEL_TIME_MIN
```
    Default travel time (in minutes) when travel time cannot be determined.
    
    See Also:
    Constant Field Values
- Method Detail
  - getTrip
```
public Trip getTrip()
```
    The Trip this ItineraryEntry was created from. Can be any implementation of Trip, including:
    Exact type can be determined by calling ItineraryEntry.getTripType(). The returned object may be null if it is not available.
    Returns:
    trip
  - getNotificationTime
```
public Integer getNotificationTime()
```
    Get the time (in minutes) before the scheduled departure time to notify the user.
    
    Returns:
    time (in minutes)
  - getTravelTime
```
public Double getTravelTime()
```
    Gets the uncongested travel time (in minutes) from the given origin to the destination.
    
    Returns:
    the travel time in minutes.
  - isNotificationEnabled
```
public boolean isNotificationEnabled()
```
    Indicates whether notifications are enabled for this ItineraryEntry.
    
    Returns:
    true if notifications are enabled, false otherwise
  - getDateTime
```
public Date getDateTime()
```
    The date/time of this Trip instance (UTC).
    
    Returns:
    scheduled date/time
  - getSuggestedDepartureTime
```
public Date getSuggestedDepartureTime()
```
    Gets the suggested departure time based on the uncongested travel time. If ItineraryEntry.getScheduleType() is Schedule.ScheduleType.DEPARTURE, then return the Date returned via ItineraryEntry.getDateTime(). Otherwise return the suggested departure time based on the arrival time and the uncongested travel time. In case of ItineraryEntry.TripType.CALENDAR, which has no travel time, the travel time will be ItineraryEntry.DEFAULT_TRAVEL_TIME_MIN.
    
    Returns:
    the suggested departure time. Returns null if the the associated trip has no date time.
  - getApproximateArrivalTime
```
public Date getApproximateArrivalTime()
```
    Gets the approximate arrival time based on the uncongested travel time. If ItineraryEntry.getScheduleType() is Schedule.ScheduleType.ARRIVAL, then return the Date returned via ItineraryEntry.getDateTime(). Otherwise return the approximated arrival time based on the departure time plus travel time. In case of ItineraryEntry.TripType.CALENDAR, which has no travel time, the travel time will be ItineraryEntry.DEFAULT_TRAVEL_TIME_MIN.
    
    Returns:
    the suggested departure time. Returns null if the the associated trip has no date time.
  - getScheduleType
```
public Schedule.ScheduleType getScheduleType()
```
    Get the type of schedule for the ItineraryEntry.
    
    Returns:
    type of schedule
    See Also:
    Schedule.ScheduleType
  - getOrigin
```
public TripPoint getOrigin()
```
    Get the origin of the Trip.
    
    Returns:
    origin of the Trip, or null if not available
  - getDestination
```
public TripPoint getDestination()
```
    Get the final destination of the Trip.
    
    Returns:
    destination of the Trip
  - getWaypoints
```
public List<TripPoint> getWaypoints()
```
    Get the ordered list of waypoints along the Trip.
    
    Returns:
    ordered list of waypoints along the Trip
  - getTripType
```
public ItineraryEntry.TripType getTripType()
```
    Get the type of Trip which this ItineraryEntry was created from.
    
    Returns:
    trip type
  - isFuelRequired
```
public boolean isFuelRequired()
```
    Get the fuel status for this ItineraryEntry. If available, the fuel status indicates whether the user should factor in time to refuel in addition to the travel time.
    
    Returns:
    true if additional fuel is required to complete this trip, false otherwise or if fuel level cannot be determined
  - getAssociatedTrips
```
public List<Trip> getAssociatedTrips()
```
    Get the List of Trips which are associated with this ItineraryEntry.
    This is usually an indication that there are multiple trips for the same origin, destination, time and can be used to determine what the user's preferred route for a specific ItineraryItem is.
    
    Returns:
    List of associated Trips
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ItineraryEntry

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TRAVEL_TIME_MIN

Method Detail

getTrip

getNotificationTime

getTravelTime

isNotificationEnabled

getDateTime

getSuggestedDepartureTime

getApproximateArrivalTime

getScheduleType

getOrigin

getDestination

getWaypoints

getTripType

isFuelRequired

getAssociatedTrips

toString