IO2GOrdersTable

class IO2GOrdersTable

Parents
	`IO2GTable`

Brief

An interface to the Orders table.

Details

The class is an in-memory representation of the Orders table.
To keep this representation in sync with the trading server, you must instantiate the class and listen to the updates coming from the trading server. The class provides methods to find individual orders represented by the IO2GOrderTableRow.

Prerequisites

The class is available only through the use of the IO2GTableManager. An IO2GTableManager object must have the O2GTableManagerStatus.TablesLoaded status.
For complete instructions on the table manager usage, see the How to use table manager in ForexConnect API section.

Instantiating the class

To get orders information for the first time, you must obtain an instance of the class by calling the IO2GTableManager.getTable method. For example,

O2GOrdersTable ordersTable = (O2GOrdersTable)tableManager.getTable(O2GTable::Orders);

Receiving notifications about the Orders table updates

To keep the O2GOrdersTable data current, your application must listen to the Orders table updates coming from the trading server. These updates represent inserts into the table, changes of the order information, and deletions from the table. An instance of the class implementing the IO2GTableListener interface must be subscribed to the table updates. Subscription to each update type is done individually. Before the logout, you must unsubscribe the listener from every update type separately. The table below shows the subscription/unsubsription syntax for the O2GOrdersTable:

Update type	Subscribe syntax	Unsubscribe syntax
Insert	`ordersTable.subscribeUpdate(O2GTableUpdateType.INSERT, tableListener);`	`ordersTable.unsubscribeUpdate(O2GTableUpdateType.INSERT, tableListener);`
Update	`ordersTable.subscribeUpdate(O2GTableUpdateType.UPDATE, tableListener);`	`ordersTable.unsubscribeUpdate(O2GTableUpdateType.UPDATE, tableListener);`
Delete	`ordersTable.subscribeUpdate(O2GTableUpdateType.DELETE, tableListener);`	`ordersTable.unsubscribeUpdate(O2GTableUpdateType.DELETE, tableListener);`

Public Methods
columns	Gets an instance of the class that provides access to the list of table columns.
findRow	Finds a row in the `IO2GOrdersTable` by OrderID.
forEachRow	Iterates through the rows of the table.
getCell	Gets the value of a cell.
getGenericRow	Gets a generic row by its index.
getNextGenericRow	Gets the next row from the `IO2GTable`.
getNextGenericRowByColumnValue	Gets the next row from `IO2GTable` based on the column value.
getNextGenericRowByColumnValues	Gets the next row from `IO2GTable` based on any of the column values.
getNextGenericRowByMultiColumnValues	Gets the next row from `IO2GTable` based on the multiple columns values.
getNextRow	Gets the next row from the `IO2GOrdersTable`.
getNextRowByColumnValue	Gets the next row from `IO2GOrdersTable` based on the column value.
getNextRowByColumnValues	Gets the next row from `IO2GOrdersTable` based on any of the column values.
getNextRowByMultiColumnValues	Gets the next row from `IO2GOrdersTable` based on the multiple columns values.
getRow	Gets a row from the `IO2GOrdersTable` by its index.
getStatus	Gets the status of the table.
getType	Gets the type of a trading table.
isCellChanged	Defines whether the cell is changed.
isCellValid	Checks whether the cell value can be used or not.
size	Gets the number of rows in the reader.
subscribeStatus	Subscribes table listener to changes in table status.
subscribeUpdate	Subscribes table listener to table updates.
unsubscribeStatus	Unsubscribes table listener from changes in table status.
unsubscribeUpdate	Unsubscribes table listener from table updates.

back