favorites Schema
Filter Element
favorites Schema : Filter Element

Glossary Item Box

Description

The filter definition.
Namespace (none)

Diagram

Sort Element Grouping Element CrossFilter Element SelectedFields Element Where Element Sequence Filter Element

Overview

Filter
The filter definition.
Entity required xs:string
The entity being filtered.
KeepHierarchical required xs:boolean
Indicates if the filter is hierarchical. See Hierarchical Filter under Filtering a Collection of Entities.
Sequence
Where
The filter condition, analogous to the Where clause of SQL query.
SelectedFields 0..∞ xs:string
The list of fields to be displayed.
CrossFilter 0..∞
A filter linking to another entity.
Grouping 0..∞ xs:string
Group by values of a column.
Sort
The fields to sort by.

Attributes

NameTypeUseDefaultFixedDescription
Entityxs:stringrequired  The entity being filtered.
KeepHierarchicalxs:booleanrequired  Indicates if the filter is hierarchical. See Hierarchical Filter under Filtering a Collection of Entities.

Source

<xs:element name="Filter" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
                The filter definition.
            </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>
      <xs:element ref="CrossFilter" minOccurs="0" maxOccurs="unbounded"></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 being filtered.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="KeepHierarchical" use="required" type="xs:boolean">
      <xs:annotation>
        <xs:documentation>
                        Indicates if the filter is hierarchical. See Hierarchical Filter under Filtering a Collection of
                        Entities.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also