complexType BaseQueryOptions

diagram
namespace	http://base.api.ec.n2.tibco.com
properties	abstract  true
children	getTotalCount numberOfItems populateAttributeNames startPosition advancedOption
used by	element  BaseQueryOptions complexTypes  QueryOptions ReportOptions
annotation	documentation 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.
source	<xs:complexType name="BaseQueryOptions" abstract="true">   <xs:annotation>     <xs:documentation>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.</xs:documentation>   </xs:annotation>   <xs:sequence>     <xs:element name="getTotalCount" type="xs:boolean" minOccurs="0" maxOccurs="1">       <xs:annotation>         <xs:documentation>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.</xs:documentation>       </xs:annotation>     </xs:element>     <xs:element name="numberOfItems" type="xs:int" minOccurs="0" maxOccurs="1">       <xs:annotation>         <xs:documentation>Maximum number of events to return. A value of  -1 specifies that all events (matching the filter) should be returned.</xs:documentation>       </xs:annotation>     </xs:element>     <xs:element name="populateAttributeNames" type="xs:boolean" minOccurs="0" maxOccurs="1">       <xs:annotation>         <xs:documentation>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.</xs:documentation>       </xs:annotation>     </xs:element>     <xs:element name="startPosition" type="xs:int" minOccurs="0" maxOccurs="1">       <xs:annotation>         <xs:documentation>Index of the first required event.</xs:documentation>       </xs:annotation>     </xs:element>     <xs:element name="advancedOption" type="AdvancedQueryOption" minOccurs="0" maxOccurs="unbounded"/>   </xs:sequence> </xs:complexType>

element BaseQueryOptions/getTotalCount

diagram
type	xs:boolean
properties	minOcc  0 maxOcc  1 content  simple
annotation	documentation 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.
source	<xs:element name="getTotalCount" type="xs:boolean" minOccurs="0" maxOccurs="1">   <xs:annotation>     <xs:documentation>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.</xs:documentation>   </xs:annotation> </xs:element>

element BaseQueryOptions/numberOfItems

diagram
type	xs:int
properties	minOcc  0 maxOcc  1 content  simple
annotation	documentation Maximum number of events to return. A value of  -1 specifies that all events (matching the filter) should be returned.
source	<xs:element name="numberOfItems" type="xs:int" minOccurs="0" maxOccurs="1">   <xs:annotation>     <xs:documentation>Maximum number of events to return. A value of  -1 specifies that all events (matching the filter) should be returned.</xs:documentation>   </xs:annotation> </xs:element>

element BaseQueryOptions/populateAttributeNames

diagram
type	xs:boolean
properties	minOcc  0 maxOcc  1 content  simple
annotation	documentation 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.
source	<xs:element name="populateAttributeNames" type="xs:boolean" minOccurs="0" maxOccurs="1">   <xs:annotation>     <xs:documentation>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.</xs:documentation>   </xs:annotation> </xs:element>

element BaseQueryOptions/startPosition

diagram
type	xs:int
properties	minOcc  0 maxOcc  1 content  simple
annotation	documentation Index of the first required event.
source	<xs:element name="startPosition" type="xs:int" minOccurs="0" maxOccurs="1">   <xs:annotation>     <xs:documentation>Index of the first required event.</xs:documentation>   </xs:annotation> </xs:element>

element BaseQueryOptions/advancedOption

diagram
type	AdvancedQueryOption
properties	minOcc  0 maxOcc  unbounded content  complex
children	optionName optionValue
source	<xs:element name="advancedOption" type="AdvancedQueryOption" minOccurs="0" maxOccurs="unbounded"/>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy