com.inrix.sdk.model

Class SavedTrip

java.lang.Object

com.inrix.sdk.model.Trip

com.inrix.sdk.model.SavedTrip

All Implemented Interfaces:

Parcelable, Cloneable

public final class SavedTrip
extends Trip
implements Parcelable, Cloneable

A SavedTrip is a Trip the user has customized in any way and is the only type of Trip that can be saved to a user's itinerary. A SavedTrip includes a schedule and notification settings for the Trip, along with an option to override these settings for a single day (today only).

Any changes made to an existing SavedTrip or any new SavedTrip must be persisted using TripManager.saveTrip(com.inrix.sdk.TripManager.SaveTripOptions, com.inrix.sdk.TripManager.ISaveTripResponseListener). After calling saveTrip, the updated SavedTrip should be used instead of the one used to call the method.

Example: Creating a new saved trip (with no waypoints or notifications)

 // Create a TripPoint for origin
 final GeoPoint homeCoordinates = new GeoPoint(47.61527, -122.3285);
 final TripPoint origin = new TripPoint("Home", homeCoordinates);

 // Create a TripPoint for destination
 final GeoPoint workCoordinates = new GeoPoint(48.61527, -123.3285);
 final TripPoint destination = new TripPoint("Work", workCoordinates);

 // Create the schedule for this trip - remember to set timezone to UTC
 final Calendar dateTime = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
 dateTime.set(2015, 3, 1, 9, 0, 0); // Starting on March 1, 2015 at 9AM - timezone is not relevant here

 final TripSchedule.RecurringScheduleOptions scheduleOptions =
         new TripSchedule.RecurringScheduleOptions(TripSchedule.ScheduleType.DEPARTURE,
                                                   dateTime.getTime(),
                                                   Arrays.asList(Calendar.MONDAY, Calendar.TUESDAY,
                                                                 Calendar.WEDNESDAY, Calendar.THURSDAY,
                                                                 Calendar.FRIDAY));

 final TripSchedule schedule = new TripSchedule(scheduleOptions, null);

 // Create the trip
 final SavedTrip result = new SavedTrip(origin, destination, schedule);

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SavedTrip.RoutePreference RoutePreference represents the preferred route for a SavedTrip.
static class	SavedTrip.SavedTripException An exception that is thrown when there is an error with a SavedTrip operation.

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<SavedTrip>	CREATOR Parcelable creator for this type.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
SavedTrip(TripPoint origin, TripPoint destination, List<TripPoint> waypoints, Schedule schedule) Create a SavedTrip with the given origin, destination, waypoints and schedule.
SavedTrip(TripPoint origin, TripPoint destination, Schedule schedule) Create a SavedTrip with the given origin, destination and notification.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
int	describeContents()
boolean	equals(Object o)
ContactInfoCollection	getAssociatedContacts() Gets the contacts associated with current SavedTrip.
TripPoint	getDestination() Get the final destination of the SavedTrip.
TripPoint	getOrigin() Get the origin of the SavedTrip.
int	getRouteCriteria() Get the route criteria for this SavedTrip.
SavedTrip.RoutePreference	getRoutePreference() Get the route preference for this SavedTrip.
Schedule	getSchedule() Get the schedule associated with this trip.
List<TripPoint>	getWaypoints() Get the ordered list of waypoints along the SavedTrip.
int	hashCode()
void	setDestination(TripPoint destination) Set the final destination of the SavedTrip.
void	setOrigin(TripPoint origin) Set the origin of the SavedTrip.
int	setRouteCriteria(int routeCriteria) Set additional route criteria for this SavedTrip.
SavedTrip.RoutePreference	setRoutePreference(SavedTrip.RoutePreference routePreference) Set the route preference for this SavedTrip.
void	setSchedule(Schedule schedule) Set the schedule for this trip.
void	setWaypoints(List<TripPoint> waypoints) Set the ordered list of waypoints along the SavedTrip.
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<SavedTrip> CREATOR

Parcelable creator for this type.

Constructor Detail

SavedTrip

public SavedTrip(TripPoint origin,
         TripPoint destination,
         List<TripPoint> waypoints,
         Schedule schedule)

Create a SavedTrip with the given origin, destination, waypoints and schedule.

Parameters:

origin - origin of the trip, must not be null

destination - destination of the trip, must not be null

waypoints - waypoints along the trip, optional and may be null

schedule - schedule of the trip, must not be null

SavedTrip

public SavedTrip(TripPoint origin,
         TripPoint destination,
         Schedule schedule)

Create a SavedTrip with the given origin, destination and notification.

Parameters:

origin - origin of the trip, must not be null

destination - destination of the trip, must not be null

schedule - schedule of the trip, must not be null

Method Detail

writeToParcel

public void writeToParcel(Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

getOrigin

public TripPoint getOrigin()

Get the origin of the SavedTrip.

Returns:

origin of the SavedTrip

setOrigin

public void setOrigin(TripPoint origin)

Set the origin of the SavedTrip.

Parameters:

origin - origin of the SavedTrip

getDestination

public TripPoint getDestination()

Get the final destination of the SavedTrip.

Returns:

destination of the SavedTrip

setDestination

public void setDestination(TripPoint destination)

Set the final destination of the SavedTrip.

Parameters:

destination - destination of the SavedTrip

getSchedule

public Schedule getSchedule()

Get the schedule associated with this trip.

Returns:

trip schedule

setSchedule

public void setSchedule(Schedule schedule)

Set the schedule for this trip.

Parameters:

schedule - trip schedule, must not be null

setRoutePreference

public SavedTrip.RoutePreference setRoutePreference(SavedTrip.RoutePreference routePreference)

Set the route preference for this SavedTrip.

Parameters:

routePreference - route preference

Returns:

route preference the previous route preference

See Also:

SavedTrip.RoutePreference

getRoutePreference

public SavedTrip.RoutePreference getRoutePreference()

Get the route preference for this SavedTrip.

If no preference has been specified by the user, the default is SavedTrip.RoutePreference.FASTEST.

Returns:

route preference

See Also:

SavedTrip.RoutePreference

setRouteCriteria

public int setRouteCriteria(int routeCriteria)

Set additional route criteria for this SavedTrip.

The criteria is expressed as a bit field with the following possible values:

• RouteManager.ROUTE_CRITERIA_NO_RESTRICTIONS
• RouteManager.ROUTE_CRITERIA_AVOID_HIGHWAYS
• RouteManager.ROUTE_CRITERIA_AVOID_TOLL_ROADS
• RouteManager.ROUTE_CRITERIA_AVOID_FERRIES
• RouteManager.ROUTE_CRITERIA_AVOID_VIGNETTE

Parameters:

routeCriteria - route criteria

Returns:

route criteria the previous route criteria

See Also:

RouteManager

getRouteCriteria

public int getRouteCriteria()

Get the route criteria for this SavedTrip.

If no criteria has been specified by the user, the default value is RouteManager.ROUTE_CRITERIA_NO_RESTRICTIONS.

Returns:

route criteria

See Also:

RouteManager

getWaypoints

public List<TripPoint> getWaypoints()

Get the ordered list of waypoints along the SavedTrip.

Returns:

ordered list of waypoints along the SavedTrip

setWaypoints

public void setWaypoints(List<TripPoint> waypoints)

Set the ordered list of waypoints along the SavedTrip.

Parameters:

waypoints - ordered list of waypoints along the SavedTrip

getAssociatedContacts

public ContactInfoCollection getAssociatedContacts()

Gets the contacts associated with current SavedTrip.

Returns:

A list of ContactInfo associated with current saved trip.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Object clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object