org.opencms.ade.contenteditor.shared.CmsSaveResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-gwt Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

The newest version!

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.ade.contenteditor.shared;

import org.opencms.acacia.shared.CmsValidationResult;
import org.opencms.util.CmsPair;

import java.util.List;
import java.util.Map;

import com.google.gwt.user.client.rpc.IsSerializable;

/**
 * Stores the editor save result information.
 */
public class CmsSaveResult implements IsSerializable {

    /** If container element settings where changed. */
    private boolean m_hasChangedSettings;

    /** If validation warnings caused a save error. */
    private boolean m_warningsAsError;

    /** The validation result. */
    private CmsValidationResult m_validationResult;

    /**
     * Map from locale to issues with information to display in the validation result dialog.
     * It contains already the information to display, localized wrt the workplace locale
     * and in the correct order.
     *
     * The structure is:
     * { "locale" :
     *  [
     *      {
     *          first: [ { first: "elementName", second: "elementIdx" } ],
     *          second: "localized error message"
     *      }
     *  ]
     *
     */
    private Map>, String>>> m_validationIssueInformation;

    /**
     * Constructor.

     *
     * @param hasChangedSettings if container element settings where changed
     * @param validationResult the validation result
     * @param warningsAsError flag, indicating if warnings should be treated as errors
     * @param issuesToDisplay the issues (warnings or errors) to display, already localized and sorted as needed.
     */
    public CmsSaveResult(
        boolean hasChangedSettings,
        CmsValidationResult validationResult,
        boolean warningsAsError,
        Map>, String>>> issuesToDisplay) {

        m_hasChangedSettings = hasChangedSettings;
        m_validationResult = validationResult;
        m_warningsAsError = warningsAsError;
        m_validationIssueInformation = issuesToDisplay;
    }

    /**
     * Constructor for serialization only.

     */
    protected CmsSaveResult() {

    }

    /**
     * Returns the validation issue information to display.
     * @return the validation issue information to display.
     */
    public Map>, String>>> getIssueInformation() {

        return m_validationIssueInformation;
    }

    /**
     * Returns the validation result.

     *
     * @return the validation result
     */
    public CmsValidationResult getValidationResult() {

        return m_validationResult;
    }

    /**
     * Returns whether the validation result has errors.

     *
     * @return true in case the validation result has errors
     */
    public boolean hasErrors() {

        return (m_validationResult != null)
            && (m_validationResult.hasErrors() || (m_warningsAsError && m_validationResult.hasWarnings()));
    }

    /**
     * Returns whether container element settings where changed.
     *
     * @return true in case container element settings where changed
     */
    public boolean isHasChangedSettings() {

        return m_hasChangedSettings;
    }
}