Task

  • Task is an abstract class representing a single action to track within the Last Mile Fleet Solution system, such as a delivery or a step in a ridesharing trip.

  • It provides methods to access task details including its type, state, outcome, planned waypoint, duration, and associated identifiers like taskId, trackingId, providerId, and vehicleId.

  • Task includes nested interfaces (TaskOutcome, TaskState, TaskType) for defining the possible values for task attributes.

  • Developers can extend the Task class to create specific task implementations like DeliveryTask for delivery-related actions.

  • Although getParentId() is deprecated, developers should use getTrackingId() to access the identifier for a group of related tasks.

public abstract class Task extends Object
Known Direct Subclasses

A task represents a single action to track in the Last Mile Fleet Solution system.

Nested Class Summary

@interface Task.TaskOutcome The outcome of an attempt to execute a task. 
@interface Task.TaskState The state of a Task indicating its progression. 
@interface Task.TaskType The type of a Task. 

Public Constructor Summary

Public Method Summary

final String
getParentId()
This method is deprecated. Instead call getTrackingId().
abstract Waypoint
getPlannedWaypoint()
Returns the planned waypoint destination where the task will be completed.
abstract String
getProviderId()
Returns the unique identifier for this provider.
abstract long
getTaskDurationSeconds()
Returns the additional time to perform an action at this location, measured in seconds.
abstract String
getTaskId()
Returns the unique identifier for this task for this provider.
abstract String
getTaskName()
Returns the full name, including the task id, for this task among all providers.
abstract int
getTaskOutcome()
Returns the outcome of the closed task.
abstract Long
getTaskOutcomeTimestamp()
Returns the timestamp in milliseconds for when the task outcome was set.
abstract int
getTaskState()
Returns the state of the task with respect to lifecycle of a task.
abstract int
getTaskType()
Returns the type of task.
abstract String
getTrackingId()
Returns the tracking ID of the task.
abstract String
getVehicleId()
Returns the identifier for the vehicle assigned to this task.

Inherited Method Summary

Public Constructors

public Task ()

Public Methods

public final String getParentId ()

This method is deprecated.
Instead call getTrackingId().

Returns the parent ID of the task. This corresponds to the set of related tasks to accomplish one goal (e.g. a ridesharing trip, or a package delivery).

public abstract Waypoint getPlannedWaypoint ()

Returns the planned waypoint destination where the task will be completed.

public abstract String getProviderId ()

Returns the unique identifier for this provider.

public abstract long getTaskDurationSeconds ()

Returns the additional time to perform an action at this location, measured in seconds.

public abstract String getTaskId ()

Returns the unique identifier for this task for this provider.

public abstract String getTaskName ()

Returns the full name, including the task id, for this task among all providers. This is not a "tracking_id", which can have multiple tasks with the same identifier.

public abstract int getTaskOutcome ()

Returns the outcome of the closed task.

public abstract Long getTaskOutcomeTimestamp ()

Returns the timestamp in milliseconds for when the task outcome was set.

public abstract int getTaskState ()

Returns the state of the task with respect to lifecycle of a task.

public abstract int getTaskType ()

Returns the type of task. These values can differ depending on the vertical or can allow for a driver to be operating within multiple verticals at once.

public abstract String getTrackingId ()

Returns the tracking ID of the task. This corresponds to the set of related tasks to accomplish one goal (e.g. a ridesharing trip, or a package delivery).

public abstract String getVehicleId ()

Returns the identifier for the vehicle assigned to this task.