Java SDK for 2D
 All Classes Namespaces Functions Variables Pages
ApiHistory Class Reference

Static Public Member Functions

static void addStopOffPointToHistory (HistoryRecord historyRecord, int maxTime) throws GeneralException
 Adds new item to History list. More...
 
static ArrayList< HistoryRecordgetHistoryList (boolean searchAddress, int maxTime) throws GeneralException
 Returns the list of items in History. More...
 

Member Function Documentation

static void addStopOffPointToHistory ( HistoryRecord  historyRecord,
int  maxTime 
) throws GeneralException
static

Adds new item to History list.

Parameters
historyRecordHistoryRecord instance which contains information about item to add.
maxTimeMaximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.
Exceptions
GeneralExceptionthe general exception

References Api.getInstance(), Api.getService(), and HistoryRecord.writeBundle().

static ArrayList<HistoryRecord> getHistoryList ( boolean  searchAddress,
int  maxTime 
) throws GeneralException
static

Returns the list of items in History.

Parameters
searchAddressSpecify whether getHistoryList searches for address or not. If searchAddress=true, GetHistoryList fills address member of each HistoryArr item
maxTimeMaximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.
Returns
ArrayList containing HistoryRecord instances
Exceptions
GeneralExceptionthe general exception

References Api.getInstance(), Api.getService(), and HistoryRecord.readBundle().