NavigationTransactionRecorder

AI-generated Key Takeaways

• The NavigationTransactionRecorder class provides methods for recording passenger or delivery pickups and dropoffs associated with unique transaction IDs.

• It includes utility methods for generating unique transaction IDs and is designed for use by Mobility Services customers.

• The pickup and dropoff methods should be called when a passenger or delivery is picked up or dropped off, respectively, along with a list of associated transaction IDs.

• This class is thread-safe, meaning it can be safely used by multiple threads concurrently.

public class NavigationTransactionRecorder extends Object

Contains methods for recording transactions.

This class should only be used by Mobility Services customers.

This class is thread-safe.

Nested Class Summary

class

NavigationTransactionRecorder.TransactionException

An exception thrown when trying to record a transaction with invalid input.

Public Method Summary

void	dropoff(Waypoint waypoint, List<String> transactionIds) Should be called each time a passenger or delivery is dropped off.
static String	generateTransactionId() Utility method to generate a new unique transaction ID.
void	pickup(Waypoint waypoint, List<String> transactionIds) Should be called each time a passenger or delivery is picked up.

Inherited Method Summary

From class java.lang.Object

boolean	equals(Object arg0)
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public void dropoff (Waypoint waypoint, List<String> transactionIds)

Should be called each time a passenger or delivery is dropped off. The transactionIds parameter should be populated with unique string identifiers for one or more transactions that apply to this event.

Each transaction ID must be at most 64 characters long, and there is a maximum of 100 transaction IDs per call.

This method should only be used by Mobility Services customers.

Parameters

waypoint	the navigation Waypoint at which the dropoff is occurring, or null if there was no navigation session leading to this dropoff
transactionIds	one or more transaction IDs to which this dropoff applies. A transaction ID is an arbitrary string that is unique for each billable transaction.

Throws

NavigationTransactionRecorder.TransactionException	if the list of transaction IDs is invalid

public static String generateTransactionId ()

Utility method to generate a new unique transaction ID.

public void pickup (Waypoint waypoint, List<String> transactionIds)

Should be called each time a passenger or delivery is picked up. The transactionIds parameter should be populated with unique string identifiers for one or more transactions that apply to this event.

Each transaction ID must be at least 1 and at most 64 characters long, and there is a maximum of 100 transaction IDs per call.

This method should only be used by Mobility Services customers.

Parameters

waypoint	the navigation Waypoint at which the pickup is occurring, or null if there was no navigation session leading to this pickup
transactionIds	one or more transaction IDs to which this pickup applies. A transaction ID is an arbitrary string that is unique for each billable transaction.

Throws

NavigationTransactionRecorder.TransactionException	if the list of transaction IDs is invalid.