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

Source: entity/js/api/PropertyClassification.js

define([], function () {

    'use strict';

    /**
     * Classification of {@link entity/js/api/Property properties} into some logical groups used in UI presentation.
     *
     * <p>
     * For example if {@link entity/js/api/Property Property} is marked as {@link entity/js/api/PropertyClassification.IGNORE PropertyClassification.IGNORE},
     * Application Builder will ignore such a {@link entity/js/api/Property Property} on all relevant places in the UI. That can be handy for some hidden attributes
     * which you don't want to present to the end-user.
     * </p>
     *
     * @AbcsAPI stable
     * @version 17.1.1
     * @exports entity/js/api/PropertyClassification
     *
     * @private
     * @constructor
     *
     * @see {@link bop/js/api/entity/DataModelFactory#createProperty DataModelFactory.createProperty(..)} to check where <code>PropertyClassification</code> can be used.
     */
    var PropertyClassification = function() {
        AbcsLib.throwStaticClassError();
    };

    /**
     * Marks typical {@link entity/js/api/Property Property} with no special treatment.
     *
     * @AbcsAPI stable
     * @version 17.1.1
     * @static
     * @constant
     * @type {String}
     */
    PropertyClassification.BASIC = 'BASIC';

    /**
     * Internal property classification.
     * @type {string}
     */
    PropertyClassification.INTERNAL = 'INTERNAL';

    /**
     * Marks {@link entity/js/api/Property Property} which is ignored by the Application Builder UI.
     *
     * @AbcsAPI stable
     * @version 17.1.1
     * @static
     * @constant
     * @type {String}
     */
    PropertyClassification.IGNORE = 'IGNORE';

    return PropertyClassification;
});