JavaScript Extension Development API for Oracle Visual Builder Cloud Service - Classic Applications

Source: bop.dt/js/api/BOPExtensionDependencyFormat.js

define([], function () {

    'use strict';

    /**
     * Defines the <b>format</b> of the dependency to an ABCS BOP extension.
     * This dependency should be added to the array of {@link module:extensions.dt/js/spi/ExtensionManager.Dependency ExtensionManager.Dependency} objects that
     * is passed to the {@link extensions.dt/js/spi/ExtensionManager#initialise ExtensionManager.initialise} and
     * {@link extensions.dt/js/spi/ExtensionManager#destroy ExtensionManager.destroy} methods.
     *
     * @AbcsExtension stable
     * @typedef bop.dt/js/spi/BOPExtensionManager~BOPExtensionDependencyFormat
     * @version 17.1.1
     * @property {string} businessObjects - Contains an array of dependencies descriptions of the BOP extension.
     *
     * @example <caption>An example of a dependency to a BOP extension</caption>
     * {
     *  "businessObjects": [
     *     {
     *         "my.BO": ["id","name","address"],    // selected properties from BO entity, "my.BO" is the BO's id
     *         "my.other.BO": "*"                   // all properties
     *     }
     *  ]
     * }
     * or
     * {
     *  "businessObjects": "*"                      // all business objects and properties
     * }
     * or ommit the dependency definition completely
     * {
     *                                              // all business objects and properties
     * }
     */
    function BOPExtensionDependencyFormat() {
        AbcsLib.throwStaticClassError();
    }

    /**
     * Contains an array of dependencies descriptions of the BOP extension.
     *
     * @type {String}
     */
    BOPExtensionDependencyFormat.businessObjects = 'businessObjects';

    return BOPExtensionDependencyFormat;

});