Class: ReportOptions

tibco.objectapi.ec.base.ReportOptions

new ReportOptions()

The options available when generating the report. Constructs a new ReportOptions.

The following features are supported:

Extends

Members

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

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

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
Inherited From:

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
Inherited From:

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
Inherited From:

requireAllAttributes :boolean

Boolean value defining whether all attributes should be returned. This setting overrides any "requiredAttribute" elements. This property holds the value of the 'Require All Attributes' attribute.
Type:
  • boolean

requiredAttribute :Array.<string>

List of attributes that should be returned for each event found by this query. This property holds the value of the 'Required Attribute' attribute list.
Type:
  • Array.<string>

sortOrder :Array.<tibco.objectapi.ec.base.SortElement>

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

startPosition :number

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

version :tibco.objectapi.ec.base.Version

This property holds the value of the 'Version' attribute.
Type: