O2GOrdersTableResponseReader

class O2GOrdersTableResponseReader

Parents
	`O2GGenericTableResponseReader`

Brief

The class reads a stream of order rows coming from the trading server.

Details

All data from the trading server come in the form of responses. The response type depends on the request type. An O2GResponse object of the GetOrders type comes from the trading server as a response to the request for initial order information. The response consists of the Orders table rows. Every row is represented by an O2GOrderRow object. In order to read this response, you must use the O2GOrdersTableResponseReader.

Getting the response

If your application uses the O2GTableManager, the Orders table is always loaded during the login process. This information is kept in an O2GOrdersTable object.

If your application does not use the O2GTableManager, the initial order information needs to be requested.
Depending on the trading server settings, the Orders table may or may not be loaded by the server automatically during the login process. To determine whether the table is loaded or not and what follow-up action is required to obtain the GetOrders response, use the returned value of the O2GLoginRules.isTableLoadedByDefault method with the O2GTableType.Orders argument:

Returned Value

Follow-up action

true

Call the O2GLoginRules.getTableRefreshResponse method. For example,

O2GResponse ordersResponse = loginRules.getTableRefreshResponse(O2GTableType.Orders);

false

Create a request to get initial order information for an account by using the O2GRequestFactory.createRefreshTableRequestByAccount method. For example,

O2GRequest request = requestFactory.createRefreshTableRequestByAccount(O2GTableType.Orders, mOrderID);

In this case, an instance of the O2GResponse class is the response parameter in your implementation of the IO2GResponseListener.onRequestCompleted method.

Instantiating the class

After receiving the GetOrders response, an instance of the O2GOrdersTableResponseReader class can be obtained by calling the O2GResponseReaderFactory.createOrdersTableReader method. For example:

O2GResponseReaderFactory responseFactory = session.getResponseReaderFactory(); O2GOrdersTableResponseReader ordersReader = responseFactory.createOrdersTableReader(ordersResponse);

The type defined in the fxcore2.dll assembly. The namespace is fxcore2.

Public Properties
Columns	Gets an instance of the class that provides access to the list of table columns.
Count	Gets the number of rows in the reader.
Type	Gets the type of a trading table.

Public Methods
getCell	Gets the value of a cell.
getGenericRow	Gets a generic row by its index.
getRow	Gets a row from the Orders table.
isCellValid	Checks whether the cell value can be used or not.

back