@sap-cloud-sdk/core/dist/odata-common/selectable/edm-type-field.js

"use strict";
var __extends = (this && this.__extends) || (function () {
    var extendStatics = function (d, b) {
        extendStatics = Object.setPrototypeOf ||
            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
        return extendStatics(d, b);
    };
    return function (d, b) {
        if (typeof b !== "function" && b !== null)
            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
        extendStatics(d, b);
        function __() { this.constructor = d; }
        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
    };
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.EdmTypeField = void 0;
var filter_1 = require("../filter");
var complex_type_field_1 = require("./complex-type-field");
var field_1 = require("./field");
/**
 * Represents a property of an OData entity with an EDM type.
 *
 * `EdmTypeField`s are used as static properties of entities or EDM typed fields of complex type fields. They are generated from the OData metadata, i.e. for each property of
 * an OData entity, that has an EDM type, there is one static instance of `EdmTypeField` (or rather one of its subclasses) in the corresponding generated class file.
 * `EdmTypeField`s are used to represent the domain of more or less primitive values that can be used in select, filter and order by functions.
 * For example, when constructing a query on the BusinessPartner entity, an instance of `EdmTypeField<BusinessPartner, string>`
 * can be supplied as argument to the select function, e.g. `BusinessPartner.FIRST_NAME`.
 *
 * See also: [[Selectable]]
 * @typeparam EntityT - Type of the entity the field belongs to
 * @typeparam EdmOrFieldT - EDM type of the field. Deprecated: Field type of the field.
 * @typeparam NullableT - Boolean type that represents whether the field is nullable.
 * @typeparam SelectableT - Boolean type that represents whether the field is selectable.
 */
var EdmTypeField = /** @class */ (function (_super) {
    __extends(EdmTypeField, _super);
    /**
     * Creates an instance of EdmTypeField.
     * @param fieldName - Actual name of the field used in the OData request.
     * @param _fieldOf - Constructor type of the entity the field belongs to.
     * @param edmType - Type of the field according to the metadata description.
     * @param fieldOptions - Optional settings for this field.
     */
    function EdmTypeField(fieldName, _fieldOf, edmType, fieldOptions) {
        var _this = _super.call(this, fieldName, complex_type_field_1.getEntityConstructor(_fieldOf), fieldOptions) || this;
        _this._fieldOf = _fieldOf;
        _this.edmType = edmType;
        return _this;
    }
    /**
     * Creates an instance of Filter for this field and the given value using the operator 'eq', i.e. `==`.
     * @param value - Value to be used in the filter
     * @returns The resulting filter
     */
    EdmTypeField.prototype.equals = function (value) {
        return new filter_1.Filter(this.fieldPath(), 'eq', value, this.edmType);
    };
    /**
     * Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. `!=`.
     * @param value - Value to be used in the filter
     * @returns The resulting filter
     */
    EdmTypeField.prototype.notEquals = function (value) {
        return new filter_1.Filter(this.fieldPath(), 'ne', value, this.edmType);
    };
    /**
     * Path to the field to be used in filter and order by queries.
     * @returns Path to the field to be used in filter and order by queries.
     */
    EdmTypeField.prototype.fieldPath = function () {
        return this._fieldOf instanceof complex_type_field_1.ComplexTypeField
            ? this._fieldOf.fieldPath() + "/" + this._fieldName
            : this._fieldName;
    };
    return EdmTypeField;
}(field_1.Field));
exports.EdmTypeField = EdmTypeField;
//# sourceMappingURL=edm-type-field.js.map