/// <summary>
/// Filters the list with the given filters.
///
/// If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling {@link #filter}.
/// </summary>
/// <param name="sFilterType">The filter type to be used</param>
/// <returns><code>this</code> to facilitate method chaining</returns>
public extern virtual sap.ui.model.odata.v4.ODataListBinding filter(sap.ui.model.FilterType sFilterType = sap.ui.model.FilterType.Application);
/// <summary> /// Filters the tree according to the filter definitions. /// /// The filtering is applied recursively through the tree. The parent nodes of filtered child nodes will also be displayed if they don't match the filter conditions. All filters belonging to a group (=have the same path) are ORed and after that the results of all groups are ANDed. /// </summary> /// <param name="aFilters">Single filter object or an array of filter objects</param> /// <param name="sFilterType">Type of the filter which should be adjusted, if it is not given, the standard behaviour applies</param> /// <returns><code>this</code> to facilitate method chaining</returns> public extern virtual sap.ui.model.ClientTreeBinding filter(Union <sap.ui.model.Filter, sap.ui.model.Filter[]> aFilters, sap.ui.model.FilterType sFilterType);
/// <summary>
/// Applies the given filters to the ODataTreeBinding. Please note that "Control" filters are not supported for OperationMode.Server, here only "Application" filters are allowed. Filters given via the constructor are always Application filters and will be send with every backend-request. Please see the constructor documentation for more information.
///
/// Since 1.34.0 complete clientside filtering is supported for OperationMode.Client and in OperationMode.Auto, in case the backend-count is lower than the threshold. In this case all control and application filters will be applied on the client. See also: {@link sap.ui.model.odata.OperationMode.Auto}, {@link sap.ui.model.FilterType}.
///
/// For the OperationMode.Client and OperationMode.Auto, you may also specify the "useServersideApplicationFilters" constructor binding parameter. If this is set, the Application filters will always be applied on the backend, and thus trigger an OData request. Please see the constructor documentation for more information.
/// </summary>
/// <param name="aFilters"></param>
/// <param name="sFilterType">Type of the filter which should be adjusted, if it is not given, the standard behaviour FilterType.Client applies</param>
/// <returns>returns <code>this</code> to facilitate method chaining</returns>
public extern virtual sap.ui.model.odata.v2.ODataTreeBinding filter(Union <sap.ui.model.Filter[], sap.ui.model.Filter> aFilters, sap.ui.model.FilterType sFilterType);
/// <summary> /// Filters the tree according to the filter definitions. /// </summary> /// <param name="aFilters">Array of sap.ui.model.Filter objects</param> /// <param name="sFilterType">Type of the filter which should be adjusted, if it is not given, the standard behaviour applies</param> public extern virtual void filter(sap.ui.model.Filter[] aFilters, sap.ui.model.FilterType sFilterType);
/// <summary> /// Filters the list. /// /// When using <code>sap.ui.model.Filter</code> the filters are first grouped according to their binding path. All filters belonging to the same group are combined with OR and after that the results of all groups are combined with AND. Usually this means, all filters applied to a single table column are combined with OR, while filters on different table columns are combined with AND. Please note that a custom filter function is only supported with operation mode <code>sap.ui.model.odata.OperationMode.Client</code>. /// </summary> /// <param name="aFilters">Single filter or array of filter objects</param> /// <param name="sFilterType">Type of the filter which should be adjusted. If it is not given, the standard behaviour applies</param> /// <param name="bReturnSuccess">Whether the success indicator should be returned instead of <code>this</code></param> /// <returns>Reference to <code>this</code> to facilitate method chaining or a boolean success indicator</returns> public extern virtual sap.ui.model.ListBinding filter(Union <sap.ui.model.Filter, sap.ui.model.Filter[]> aFilters, sap.ui.model.FilterType sFilterType, bool bReturnSuccess = false);
/// <summary>
/// Applies a new set of filters to the list represented by this binding.
///
/// See {@link sap.ui.model.ListBinding#filter ListBinding#filter} for a more detailed description of list filtering.
///
/// When no <code>sFilterType</code> is given, any previously configured application filters are cleared and the given filters are used as control filters
/// </summary>
/// <param name="aFilters">Array of filter objects</param>
/// <param name="sFilterType">Type of the filter which should be adjusted; if no type is given, then any previously configured application filters are cleared and the given filters are used as control filters</param>
/// <returns>returns <code>this</code> to facilitate method chaining</returns>
public extern override sap.ui.model.ListBinding filter(sap.ui.model.Filter[] aFilters, sap.ui.model.FilterType sFilterType);
/// <summary> /// Applies a new set of filters to the list represented by this binding. /// /// Depending on the nature of the model (client or server), the operation might be executed locally or on a server and it might execute asynchronously. /// /// <h4>Application and Control Filters</h4> Each list binding maintains two separate lists of filters, one for filters defined by the control that owns the binding and another list for filters that an application can define in addition. When executing the filter operation, both sets of filters are combined. /// /// By using the second parameter <code>sFilterType</code> of method <code>filter</code>, the caller can control which set of filters is modified. If no type is given, then the behavior depends on the model implementation and should be documented in the API reference for that model. /// /// <h4>Auto-Grouping of Filters</h4> Filters are first grouped according to their binding path. All filters belonging to the same group are ORed and after that the results of all groups are ANDed. Usually this means, all filters applied to a single table column are ORed, while filters on different table columns are ANDed. Please either use the automatic grouping of filters (where applicable) or use explicit AND/OR filters, a mixture of both is not supported. /// </summary> /// <param name="aFilters">Array of filter objects</param> /// <param name="sFilterType">Type of the filter which should be adjusted; if no type is given, the behavior depends on the model implementation</param> /// <returns>returns <code>this</code> to facilitate method chaining</returns> public extern virtual sap.ui.model.ListBinding filter(sap.ui.model.Filter[] aFilters, sap.ui.model.FilterType sFilterType);
/// <summary> /// Filters the list. /// /// When using sap.ui.model.Filter the filters are first grouped according to their binding path. All filters belonging to a group are combined with OR and after that the results of all groups are combined with AND. Usually this means, all filters applied to a single table column are combined with OR, while filters on different table columns are combined with AND. Please note that a custom filter function is not supported. /// </summary> /// <param name="aFilters">Array of filter objects</param> /// <param name="sFilterType">Type of the filter which should be adjusted, if it is not given, the standard behaviour applies</param> /// <returns>returns <code>this</code> to facilitate method chaining</returns> public extern virtual sap.ui.model.ListBinding filter(Union <sap.ui.model.Filter[], sap.ui.model.odata.Filter[]> aFilters, sap.ui.model.FilterType sFilterType);
/// <summary> /// Sets filters for matching only a subset of the entities in the bound OData entity set. /// /// Invoking this function resets the state of the binding. Subsequent data requests such as calls to getNodeContexts() will need to trigger OData requests in order to fetch the data that are in line with these filters. /// </summary> /// <param name="aFilter">an Array of sap.ui.model.Filter objects or a single Filter instance.</param> /// <param name="sFilterType">Type of the filter which should be adjusted.</param> /// <returns>returns <code>this</code> to facilitate method chaining</returns> public extern virtual sap.ui.model.analytics.AnalyticalBinding filter(Union <sap.ui.model.Filter[], sap.ui.model.Filter> aFilter, sap.ui.model.FilterType sFilterType = sap.ui.model.FilterType.Control);
