Class: BaseQueryOptions

tibco.objectapi.ec.base.BaseQueryOptions

new BaseQueryOptions()

Execution-time options to be used with this query. These include: - paging options for the query. - runtime QueryParameters that should be used for any late-bound parameters specified in the query. Constructs a new BaseQueryOptions.
N.B. This is an abstract class - do not instantiate!

The following features are supported:

Members

advancedOption :Array.<tibco.objectapi.ec.base.AdvancedQueryOption>

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

getTotalCount :boolean

Boolean value defining whether to return a count of the total number of items the query could return (if startPosition was specified as 0 and numberOfItems as -1). Setting this flag has some performance impact. This property holds the value of the 'Get Total Count' attribute.
Type:
  • boolean

numberOfItems :number

Maximum number of events to return. A value of -1 specifies that all events (matching the filter) should be returned. This property holds the value of the 'Number Of Items' attribute.
Type:
  • number

populateAttributeNames :boolean

This option controls whether attribute names will be included in all returned attributes from the query. Where the QueryTarget refers to a table where id's are not applicable, this option will be ignored. This property holds the value of the 'Populate Attribute Names' attribute.
Type:
  • boolean

startPosition :number

Index of the first required event. This property holds the value of the 'Start Position' attribute.
Type:
  • number