webgme-engine/src/plugin/InterPluginResult.js

WebGME server and Client API without a GUI

/*globals define*/
/*eslint-env node, browser*/

/**
 * A module representing the result from an invoked plugin.
 * @author pmeijer / https://github.com/meijer
 */

(function (factory) {
    if (typeof define === 'function' && define.amd) {
        define(['plugin/PluginResultBase'], factory);
    } else if (typeof module === 'object' && module.exports) {
        module.exports = factory(require('./PluginResultBase'));
    }
}(function (PluginResultBase) {
    'use strict';

    /**
     * Initializes a new instance of a plugin result object passed from an invoked plugin.
     * @constructor
     * @augments PluginResultBase
     * @alias InterPluginResult
     */
    var InterPluginResult = function (pluginInstance) {
        this.success = false;
        this.artifacts = [];
        this.messages = [];
        this.commitMessages = [];

        this.pluginInstance = pluginInstance;
        this.pluginName = pluginInstance.getName();
    };

    // Prototypical inheritance from PluginResultBase.
    InterPluginResult.prototype = Object.create(PluginResultBase.prototype);
    InterPluginResult.prototype.constructor = InterPluginResult;

    /**
     * Adds commit message to result.
     * @param {string} message
     */
    InterPluginResult.prototype.addCommitMessage = function (message) {
        this.commitMessages.push(message);
    };

    /**
     * Gets the added commitMessages.
     * @param {string[]} messages
     */
    InterPluginResult.prototype.getCommitMessages = function () {
        return this.commitMessages;
    };

    return InterPluginResult;
}));