net.rim.device.api.lbs.travel
Class TravelTime

An instance of this class is returned by the TravelTimeEstimator
class to provide the travel time estimate. This class also provides the
original values that were used to determine the travel time estimate.

This class provides a default constructor and setter method. These methods
can be used to construct a TravelTime object for general purpose
use, such as automated testing.

setEnd

Note: The Coordinates class is mutable and this method does
not make a copy of the object.

Since:

BlackBerry API 6.0.0

getStartTime

public long getStartTime()

Retrieves the time at which travel is to start. The travel time estimate
is valid only for travel at the specified start time. If
TravelTime.START_NOW was specified when you requested the travel time
estimate, this method returns the actual time at which the estimate was
received from the Travel Time service.

Returns:

The time at which travel is to start. The time is expressed in
milliseconds since January 1, 1970 00:00:00 GMT, which
corresponds to the value returned by the
java.util.Date.getTime() method.

Since:

BlackBerry API 6.0.0

setStartTime

public void setStartTime(long startTime)

Sets the time at which travel is to start.

Parameters:

startTime - The time at which travel is to start. The value is the
number of milliseconds since January 1, 1970, 00:00:00 GMT, which
is the value returned by the java.util.Date.getTime() method. To indicate that travel will
start immediately, pass TravelTime.START_NOW.

Since:

BlackBerry API 6.0.0

getEndTime

public long getEndTime()

Retrieves the arrival time at the destination.

Returns:

The time of arrival at the destination. The time is expressed in
milliseconds since January 1, 1970 00:00:00 GMT, which
corresponds to the value returned by the
java.util.Date.getTime() method.

Since:

BlackBerry API 7.0.0

setEndTime

public void setEndTime(long endTime)

Sets the arrival time at the destination.

Parameters:

endTime - The arrival time at the destination. The value is the
number of milliseconds since January 1, 1970, 00:00:00 GMT, which
is the value returned by the java.util.Date.getTime() method.

Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.Java is a trademark of Oracle America Inc. in the US and other countries.Legal