Class: Result

tibco.objectapi.ec.base.Result

new Result()

Information returned by an executeQueryResponse message. The Result object contains summary information followed by a list of the events returned by the query. Constructs a new Result.

The following features are supported:

Members

endPosition :number

Index of the last event returned by the query. This will correlate with either: - the numberOfItems + startPosition properties specified in the QueryOptions for the query, or - the end of the results returned by the query. This property holds the value of the 'End Position' attribute.
Type:
  • number

event :Array.<tibco.objectapi.ec.base.Event>

This property holds the value of the 'Event' containment reference list.
Type:

startPosition :number

Index of the first event returned by the query. This will correlate with the startPosition specified in QueryOptions in the query request. This property holds the value of the 'Start Position' attribute.
Type:
  • number

totalItems :string

Total number of items the query could have returned (if it had specified its startPosition as 0 and numberOfItems as -1). For performance reasons, totalItems is only returned if the getTotalItems flag was specified in QueryOptions in the query request. This property holds the value of the 'Total Items' attribute.
Type:
  • string