Description
A filter linking to another entity.
Diagram
Overview
 |
 |
Entity required xs:string
The entity crossed with the prime entity in his filter.
|
 |
RelationName optional xs:string
The name of the relation this cross-filter refers to. Null if this cross-filter refers to a legacy cross-filter name. See the OTA documentation for legacy cross-filter names.
|
 |
legacyXFilterName optional xs:string
The legacy name of the cross filter.
|
 |
Inclusive required xs:boolean
If true, returns only entities that have relations to the entity the cross filter refers to.
|
 |
Sequence
 |
Where
The filter condition, analogous to the Where clause of SQL query.
|
 |
Grouping 0..∞ xs:string
Group by values of a column.
|
 |
Sort
The fields to sort by.
|
|
|
Attributes
Name | Type | Use | Default | Fixed | Description |
Entity | xs:string | required | | | The entity crossed with the prime entity in his filter. |
RelationName | xs:string | optional | | | The name of the relation this cross-filter refers to. Null if this cross-filter refers to a legacy cross-filter name. See the OTA documentation for legacy cross-filter names. |
legacyXFilterName | xs:string | optional | | | The legacy name of the cross filter. |
Inclusive | xs:boolean | required | | | If true, returns only entities that have relations to the entity the cross filter refers to. |
Source
<xs:element name="CrossFilter" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:annotation>
<xs:documentation>
A filter linking to another entity.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="Where"></xs:element>
<xs:element name="SelectedFields" minOccurs="0" maxOccurs="unbounded" type="xs:string">
<xs:annotation>
<xs:documentation>
The list of fields to be displayed.
</xs:documentation>
</xs:annotation>
</xs:element>
<!-- this Grouping element was added as temoprary fix to support grouping in favorite filter. it will be removed in future version-->
<xs:element name="Grouping" minOccurs="0" maxOccurs="unbounded" type="xs:string">
<xs:annotation>
<xs:documentation>
Group by values of a column.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="Sort"></xs:element>
</xs:sequence>
<xs:attribute name="Entity" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>
The entity crossed with the prime entity in his filter.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="RelationName" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of the relation this cross-filter refers to. Null if this cross-filter refers to a
legacy cross-filter name. See the OTA documentation for legacy cross-filter names.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="legacyXFilterName" type="xs:string">
<xs:annotation>
<xs:documentation>
The legacy name of the cross filter.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Inclusive" use="required" type="xs:boolean">
<xs:annotation>
<!--
Example: Given a filter on a test with links to defects.
Inclusive=true - Filter matches only tests with links to defects.
Inclusive=false - Filter matches only tests that do not have links to defects.
-->
<xs:documentation>
If true, returns only entities that have relations to the entity the cross filter refers to.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
|
See Also