/// <summary>
/// Do <strong>NOT</strong> call this private constructor, but rather use {@link sap.ui.model.odata.v4.ODataModel#bindProperty} instead!
/// </summary>
/// <param name="oModel">The OData V4 model</param>
/// <param name="sPath">The binding path in the model; must not end with a slash</param>
/// <param name="oContext">The context which is required as base for a relative path</param>
/// <param name="mParameters">Map of binding parameters</param>
public extern ODataPropertyBinding(sap.ui.model.odata.v4.ODataModel oModel, string sPath, sap.ui.model.Context oContext, object mParameters);
/// <summary> /// Creates a new list binding for the given path and optional context which must resolve to an absolute OData path for an entity set. /// </summary> /// <param name="sPath">The binding path in the model; must not be empty or end with a slash</param> /// <param name="oContext">The context which is required as base for a relative path</param> /// <returns>The list binding</returns> public extern virtual sap.ui.model.odata.v4.ODataListBinding bindList(string sPath, sap.ui.model.Context oContext);
/// <summary>
/// Creates a new property binding for the given path. This binding is inactive and will not know the property value initially. You have to call {@link sap.ui.model.Binding#initialize} to get it updated asynchronously and register a change listener at the binding to be informed when the value is available.
/// </summary>
/// <param name="sPath">The binding path in the model; must not be empty or end with a slash</param>
/// <param name="oContext">The context which is required as base for a relative path</param>
/// <returns>The property binding</returns>
public extern virtual sap.ui.model.odata.v4.ODataPropertyBinding bindProperty(string sPath, sap.ui.model.Context oContext);
/// <summary> /// Returns the value for the property with the given <code>sPropertyName</code> /// </summary> /// <param name="sPath">the path to the property</param> /// <param name="oContext">the context which will be used to retrieve the property</param> /// <returns>the value of the property</returns> public extern override object getProperty(string sPath, sap.ui.model.Context oContext);
/// <summary>
/// Creates a new list binding for the given path and optional context which must resolve to an absolute OData path for an entity set.
/// </summary>
/// <param name="sPath">The binding path in the model; must not be empty or end with a slash</param>
/// <param name="oContext">The context which is required as base for a relative path</param>
/// <param name="vSorters">The dynamic sorters to be used initially. Call {@link sap.ui.model.odata.v4.ODataListBinding#sort} to replace them. Static sorters, as defined in the '$orderby' binding parameter, are always executed after the dynamic sorters. Supported since 1.39.0.</param>
/// <param name="vFilters">The dynamic application filters to be used initially. Call {@link sap.ui.model.odata.v4.ODataListBinding#filter} to replace them. Static filters, as defined in the '$filter' binding parameter, are always combined with the dynamic filters using a logical <code>AND</code>. Supported since 1.39.0.</param>
/// <param name="mParameters">Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or binding-specific parameters as specified below. Note: The binding creates its own data service request if it is absolute or if it has any parameters or if it is relative and has a context created via {@link #createBindingContext} or if it has sorters or filters. The following OData query options are allowed: <ul> <li> All "5.2 Custom Query Options" except for those with a name starting with "sap-" <li> The $apply, $count, $expand, $filter, $levels, $orderby, $search, and $select "5.1 System Query Options" </ul> All other query options lead to an error. Query options specified for the binding overwrite model query options.</param>
/// <returns>The list binding</returns>
public extern virtual sap.ui.model.odata.v4.ODataListBinding bindList(string sPath, sap.ui.model.Context oContext, Union <sap.ui.model.Sorter, sap.ui.model.Sorter[]> vSorters, Union <sap.ui.model.Filter, sap.ui.model.Filter[]> vFilters, sap.ui.model.odata.v4.ODataModel.BindListInfo mParameters);
/// <summary> /// Returns the node with the given context, or null if no such node currently exists. /// </summary> /// <param name="oContext">The context of the node to be retrieved</param> /// <returns>The found tree node</returns> public extern virtual sap.ui.commons.TreeNode getNodeByContext(sap.ui.model.Context oContext);
/// <summary> /// Constructor for odata.ODataContextBinding /// </summary> /// <param name="oModel"></param> /// <param name="sPath"></param> /// <param name="oContext"></param> public extern ODataContextBinding(sap.ui.model.Model oModel, string sPath, sap.ui.model.Context oContext);
/// <summary> /// Sets a new value for the given property <code>sPropertyName</code> in the model. If the model value changed all interested parties are informed. /// </summary> /// <param name="sPath">path of the property to set</param> /// <param name="oValue">value to set the property to</param> /// <param name="oContext">the context which will be used to set the property</param> /// <returns>true if the value was set correctly and false if errors occurred like the entry was not found.</returns> public extern virtual bool setProperty <T>(string sPath, T oValue, sap.ui.model.Context oContext);
/// <summary>
/// Returns the value for the property with the given <code>sPath</code>.
///
/// If the path points to a navigation property which has been loaded via <code>$expand</code> then the <code>bIncludeExpandEntries</code> parameter determines if the navigation property should be included in the returned value or not. Please note that this currently works for 1..1 navigation properties only.
/// </summary>
/// <param name="sPath">Path/name of the property</param>
/// <param name="oContext">Context if available to access the property value</param>
/// <param name="bIncludeExpandEntries">@deprecated Please use {@link #getObject} function with select/expand parameters instead. This parameter should be set when a URI or custom parameter with a <code>$expand</code> system query option was used to retrieve associated entries embedded/inline. If true then the <code>getProperty</code> function returns a desired property value/entry and includes the associated expand entries (if any). Note: A copy and not a reference of the entry will be returned.</param>
/// <returns>Value of the property</returns>
public extern virtual T getProperty <T>(string sPath, sap.ui.model.Context oContext, bool bIncludeExpandEntries = false);
/// <summary> /// Sets a new value for the given property <code>sPropertyName</code> in the model. If the model value changed all interested parties are informed. /// </summary> /// <param name="sPath">path of the property to set</param> /// <param name="oValue">value to set the property to</param> /// <param name="oContext">the context which will be used to set the property</param> /// <param name="bAsyncUpdate">whether to update other bindings dependent on this property asynchronously</param> /// <returns>true if the value was set correctly and false if errors occurred like the entry was not found.</returns> public extern virtual bool setProperty(string sPath, object oValue, sap.ui.model.Context oContext, bool bAsyncUpdate);
/// <summary> /// Returns the object for the given <code>path</code> /// </summary> /// <param name="sPath">the path to the object</param> /// <param name="oContext">the context which will be used to retrieve the object</param> /// <returns>the object</returns> public extern virtual object getObject(string sPath, sap.ui.model.Context oContext);
/// <summary>
/// Creates a new JSONListBinding.
///
/// This constructor should only be called by subclasses or model implementations, not by application or control code. Such code should use {@link sap.ui.model.json.JSONModel#bindList JSONModel#bindList} on the corresponding model instance instead.
/// </summary>
/// <param name="oModel">Model instance that this binding is created for and that it belongs to</param>
/// <param name="sPath">Binding path to be used for this binding</param>
/// <param name="oContext">Binding context relative to which a relative binding path will be resolved</param>
public extern JSONListBinding(sap.ui.model.json.JSONModel oModel, string sPath, sap.ui.model.Context oContext);
/// <summary>
/// Creates a new JSONListBinding.
///
/// This constructor should only be called by subclasses or model implementations, not by application or control code. Such code should use {@link sap.ui.model.json.JSONModel#bindList JSONModel#bindList} on the corresponding model instance instead.
/// </summary>
/// <param name="oModel">Model instance that this binding is created for and that it belongs to</param>
/// <param name="sPath">Binding path to be used for this binding</param>
/// <param name="oContext">Binding context relative to which a relative binding path will be resolved</param>
/// <param name="aSorters">Initial sort order (can be either a sorter or an array of sorters)</param>
public extern JSONListBinding(sap.ui.model.json.JSONModel oModel, string sPath, sap.ui.model.Context oContext, Union <sap.ui.model.Sorter, sap.ui.model.Sorter[]> aSorters);
/// <summary> /// Constructor for ContextBinding /// </summary> /// <param name="oModel"></param> /// <param name="sPath"></param> /// <param name="oContext"></param> /// <param name="mParameters"></param> /// <param name="oEvents">object defining event handlers</param> public extern ContextBinding(sap.ui.model.Model oModel, string sPath, sap.ui.model.Context oContext, object mParameters, object oEvents);
/// <summary>
/// Creates a new ClientPropertyBinding.
///
/// This constructor should only be called by subclasses or model implementations, not by application or control code. Such code should use {@link sap.ui.model.Model#bindProperty Model#bindProperty} on the corresponding model implementation instead.
/// </summary>
/// <param name="oModel">Model instance that this binding is created for and that it belongs to</param>
/// <param name="sPath">Binding path to be used for this binding, syntax depends on the concrete subclass</param>
/// <param name="oContext">Binding context relative to which a relative binding path will be resolved</param>
/// <param name="mParameters">Map of optional parameters as defined by subclasses; this class does not introduce any own parameters</param>
public extern ClientPropertyBinding(sap.ui.model.Model oModel, string sPath, sap.ui.model.Context oContext, object mParameters);
/// <summary> /// Implement in inheriting classes /// </summary> /// <param name="sPath">the path to where to read the object</param> /// <param name="oContext">the context with which the path should be resolved</param> /// <param name="mParameters">additional model specific parameters</param> /// <returns>The value for the given path/context or <code>undefined</code> if data or entity type could not be found or was incomplete</returns> public extern virtual T getObject <T>(string sPath, sap.ui.model.Context oContext, object mParameters);
/// <summary>
/// Creates a new ClientPropertyBinding.
///
/// This constructor should only be called by subclasses or model implementations, not by application or control code. Such code should use {@link sap.ui.model.Model#bindProperty Model#bindProperty} on the corresponding model implementation instead.
/// </summary>
/// <param name="oModel">Model instance that this binding is created for and that it belongs to</param>
/// <param name="sPath">Binding path to be used for this binding, syntax depends on the concrete subclass</param>
/// <param name="oContext">Binding context relative to which a relative binding path will be resolved</param>
public extern ClientPropertyBinding(sap.ui.model.Model oModel, string sPath, sap.ui.model.Context oContext);
/// <summary> /// Implement in inheriting classes /// </summary> /// <param name="sPath">the path to where to read the object</param> /// <param name="oContext">the context with which the path should be resolved</param> /// <returns>The value for the given path/context or <code>undefined</code> if data or entity type could not be found or was incomplete</returns> public extern virtual T getObject <T>(string sPath, sap.ui.model.Context oContext);
/// <summary> /// Constructor for odata.ODataContextBinding /// </summary> /// <param name="oModel"></param> /// <param name="sPath"></param> /// <param name="oContext"></param> /// <param name="mParameters"></param> public extern ODataContextBinding(sap.ui.model.Model oModel, string sPath, sap.ui.model.Context oContext, object mParameters);
/// <summary> /// Returns the original value for the property with the given path and context. The original value is the value that was last responded by a server if using a server model implementation. /// </summary> /// <param name="sPath">the path/name of the property</param> /// <param name="oContext">the context if available to access the property value</param> /// <returns>vValue the value of the property</returns> public extern virtual T getOriginalProperty <T>(string sPath, sap.ui.model.Context oContext);
/// <summary> /// Returns a group object, at least containing a key property for group detection. May contain additional properties as provided by a custom group function. /// </summary> /// <param name="oContext">the binding context</param> /// <returns>An object containing a key property and optional custom properties</returns> public extern virtual object getGroup(sap.ui.model.Context oContext);
/// <summary>
/// Returns a <code>Promise</code> which is resolved with a map representing the <code>com.sap.vocabularies.Common.v1.ValueList</code> annotations of the given property or rejected with an error. The key in the map provided on successful resolution is the qualifier of the annotation or the empty string if no qualifier is defined. The value in the map is the JSON object for the annotation. The map is empty if the property has no <code>com.sap.vocabularies.Common.v1.ValueList</code> annotations.
/// </summary>
/// <param name="oPropertyContext">a model context for a structural property of an entity type or a complex type, as returned by {@link #getMetaContext getMetaContext}</param>
/// <returns>a Promise that gets resolved as soon as the value lists as well as the required model elements have been loaded</returns>
public extern virtual es5.Promise <object> getODataValueLists(sap.ui.model.Context oPropertyContext);
/// <summary> /// Sets a new value for the given property <code>sPropertyName</code> in the model. If the model value changed all interested parties are informed. /// </summary> /// <param name="sPath">path of the property to set</param> /// <param name="oValue">value to set the property to</param> /// <param name="oContext">the context which will be used to set the property</param> public extern virtual void setProperty(string sPath, object oValue, sap.ui.model.Context oContext);
/// <summary>
/// Do <strong>NOT</strong> call this private constructor, but rather use {@link sap.ui.model.odata.v4.ODataModel#bindList} instead!
/// </summary>
/// <param name="oModel">The OData V4 model</param>
/// <param name="sPath">The binding path in the model; must not end with a slash</param>
/// <param name="oContext">The parent context which is required as base for a relative path</param>
/// <param name="vSorters">The dynamic sorters to be used initially; supported since 1.39.0</param>
public extern ODataListBinding(sap.ui.model.odata.v4.ODataModel oModel, string sPath, sap.ui.model.Context oContext, Union <sap.ui.model.Sorter, sap.ui.model.Sorter[]> vSorters);
/// <summary>
/// Creates a new list binding for the given path and optional context which must resolve to an absolute OData path for an entity set.
/// </summary>
/// <param name="sPath">The binding path in the model; must not be empty or end with a slash</param>
/// <param name="oContext">The context which is required as base for a relative path</param>
/// <param name="vSorters">The dynamic sorters to be used initially. Call {@link sap.ui.model.odata.v4.ODataListBinding#sort} to replace them. Static sorters, as defined in the '$orderby' binding parameter, are always executed after the dynamic sorters. Supported since 1.39.0.</param>
/// <returns>The list binding</returns>
public extern virtual sap.ui.model.odata.v4.ODataListBinding bindList(string sPath, sap.ui.model.Context oContext, Union <sap.ui.model.Sorter, sap.ui.model.Sorter[]> vSorters);
/// <summary>
/// Do <strong>NOT</strong> call this private constructor, but rather use {@link sap.ui.model.odata.v4.ODataModel#bindList} instead!
/// </summary>
/// <param name="oModel">The OData V4 model</param>
/// <param name="sPath">The binding path in the model; must not end with a slash</param>
/// <param name="oContext">The parent context which is required as base for a relative path</param>
public extern ODataListBinding(sap.ui.model.odata.v4.ODataModel oModel, string sPath, sap.ui.model.Context oContext);
/// <summary>
/// Creates a new property binding for the given path. This binding is inactive and will not know the property value initially. You have to call {@link sap.ui.model.Binding#initialize} to get it updated asynchronously and register a change listener at the binding to be informed when the value is available.
/// </summary>
/// <param name="sPath">The binding path in the model; must not be empty or end with a slash</param>
/// <param name="oContext">The context which is required as base for a relative path</param>
/// <param name="mParameters">Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or the binding-specific parameter "$$groupId". Note: The binding creates its own data service request if it is absolute or if it has any parameters or if it is relative and has a context created via {@link #createBindingContext}. All "5.2 Custom Query Options" are allowed except for those with a name starting with "sap-". All other query options lead to an error. Query options specified for the binding overwrite model query options.</param>
/// <returns>The property binding</returns>
public extern virtual sap.ui.model.odata.v4.ODataPropertyBinding bindProperty(string sPath, sap.ui.model.Context oContext, sap.ui.model.odata.v4.ODataModel.BindPropertyInfo mParameters);
/// <summary>
/// Creates a new ClientTreeBinding.
///
/// This constructor should only be called by subclasses or model implementations, not by application or control code. Such code should use {@link sap.ui.model.Model#bindTree Model#bindTree} on the corresponding model implementation instead.
/// </summary>
/// <param name="oModel">Model instance that this binding is created for and that it belongs to</param>
/// <param name="sPath">Binding path pointing to the tree / array that should be bound; syntax is defined by subclasses</param>
/// <param name="oContext">Context object for this binding, mandatory when when a relative binding path is given</param>
/// <param name="aApplicationFilters">Predefined application filter, either a single instance or an array</param>
public extern ClientTreeBinding(sap.ui.model.Model oModel, string sPath, sap.ui.model.Context oContext, Union <sap.ui.model.Filter, sap.ui.model.Filter[]> aApplicationFilters);
/// <summary>
/// Creates a binding context for the given path. A relative path can only be resolved if a context is provided. Note: The parameters <code>mParameters</code>, <code>fnCallBack</code>, and <code>bReload</code> from {@link sap.ui.model.Model#createBindingContext} are not supported.
///
/// It is possible to create binding contexts pointing to metadata. A '##' is recognized as separator in the resolved path and splits it into two parts; note that '#' may also be used as separator but is deprecated since 1.51. The part before the separator is transformed into a metadata context (see {@link sap.ui.model.odata.v4.ODataMetaModel#getMetaContext}). The part following the separator is then interpreted relative to this metadata context, even if it starts with a '/'; a trailing '/' is allowed here, see {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject} for the effect it has.
///
/// A binding path may also point to an operation advertisement which is addressed with '#<namespace>.<operation>' and is part of the data payload, not the metadata. The metadata of an operation can be addressed via '##' as described above.
///
/// Examples: <ul> <li><code>/Products('42')/Name##@com.sap.vocabularies.Common.v1.Label</code> points to the "Label" annotation of the "Name" property of the entity set "Products". <li><code>/##Products/[email protected]</code> has no data path part and thus starts at the metadata root. It also points to the "Label" annotation of the "Name" property of the entity set "Products". <li><code>/Products##/</code> points to the entity type (note the trailing '/') of the entity set "Products". <li><code>/EMPLOYEES('1')/##com.sap.Action</code> points to the metadata of an action bound to the entity set "EMPLOYEES". <li><code>/EMPLOYEES('1')/#com.sap.Action</code> does not point to metadata, but to the action advertisement. </ul>
/// </summary>
/// <param name="sPath">The binding path, may be relative to the provided context</param>
/// <param name="oContext">The context which is required as base for a relative path</param>
/// <returns>The binding context with the resolved path and the model instance</returns>
public extern virtual sap.ui.model.Context createBindingContext(string sPath, sap.ui.model.Context oContext);
/// <param name="oModel"></param> /// <param name="sPath"></param> /// <param name="oContext"></param> /// <param name="aApplicationFilters">predefined filter/s (can be either a filter or an array of filters). All initial filters, will be sent with every request. Filtering on the ODataTreeBinding is only supported with initial filters.</param> public extern ODataTreeBinding(sap.ui.model.Model oModel, string sPath, sap.ui.model.Context oContext, sap.ui.model.Filter[] aApplicationFilters);