@sap/odata-v4/lib/edm/AbstractEdmOperationImport.js

OData V4.0 server library

'use strict';

const EdmAnnotation = require('./EdmAnnotation');
const Target = require('./Target');
const FullQualifiedName = require('../FullQualifiedName');
const validateThat = require('../validator/ParameterValidator').validateThat;

/**
 * {@link EdmActionImport} and {@link EdmFunctionImport} share much information, this
 * information contained in this class.
 * @abstract
 * @hideconstructor
 * @ignore
 */
class AbstractEdmOperationImport {

    /**
     * Constructor
     *
     * @param {Edm} edm The edm itself
     * @param {EdmEntityContainer} container  The entity container the target belongs to
     * @param {CsdlActionImport | CsdlFunctionImport} operationImport The operation import
     */
    constructor(edm, container, operationImport) {
        validateThat('edm', edm).truthy();
        validateThat('container', container).truthy();
        validateThat('operationImport', operationImport).truthy();

        /**
         * @type {Edm}
         * @private
         */
        this.edm = edm;

        /**
         * @type {string}
         * @private
         */
        this._name = operationImport.name;

        /**
         * @type {EdmEntityContainer}
         * @private
         */
        this._container = container;

        /**
         * @type {Target}
         * @private
         */
        this._entitySet = null;

        /**
         * @type {EdmEntitySet}
         * @private
         */
        this._returnedEntitySet = null;

        /**
         * @type {EdmAnnotation[]}
         * @private
         */
        this._annotations = null;

        /**
         * @type {CsdlActionImport | CsdlFunctionImport}
         * @private
         */
        this._operationImport = operationImport;


        if (operationImport.entitySet) {
            this._entitySet = new Target(operationImport.entitySet, container);
        }
    }

    /**
     * Return the name
     *
     * @returns {string}
     */
    getName() {
        return this._name;
    }


    /**
     * Return the full qualified name
     *
     * @returns {FullQualifiedName}
     */
    getFullQualifiedName() {
        return new FullQualifiedName(this._container.getNamespace(), this.getName());
    }


    /**
     * Return the entity set which is returned by this operation
     *
     * @returns {EdmEntitySet}
     */
    getReturnedEntitySet() {
        if (this._entitySet && !this._returnedEntitySet) {

            /**
             * @type {EdmEntityContainer}
             */
            let entityContainer = this.edm.getEntityContainer(this._entitySet.getEntityContainer());
            this._returnedEntitySet = entityContainer.getEntitySet(this._entitySet.getTargetName());
        }
        return this._returnedEntitySet;
    }


    /**
     * Return the entityContainer containing this operation import
     *
     * @returns {EdmEntityContainer}
     */
    getEntityContainer() {
        return this._container;
    }

    /**
     * Returns the annotations for this object
     * @returns {EdmAnnotation[]}
     */
    getAnnotations() {
        if (this._annotations) {
            return this._annotations;
        }

        this._annotations = [];
        for (let item of this._operationImport.annotations) {
            this._annotations.push(new EdmAnnotation(this.edm, item));
        }

        return this._annotations;
    }
}

module.exports = AbstractEdmOperationImport;