com.alkacon.acacia.shared.ValidationResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of acacia-editor-client Show documentation

A GWT based resource editor. This component is used as a part of OpenCms, 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 the Acacia Editor -
 * an open source inline and form based content editor for GWT.
 *
 * Copyright (c) Alkacon Software GmbH (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
 * 
 * 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 com.alkacon.acacia.shared;

import java.util.Map;

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

/**
 * The entity validation result containing all errors and warnings for a set of entities.
 */
public class ValidationResult implements IsSerializable {

    /** The error messages by entity and attribute. */
    private Map> m_errors;

    /** The warning messages by entity and attribute. */
    private Map> m_warnings;

    /**
     * Constructor.

     * 
     * @param errors the error messages by entity and attribute
     * @param warnings the warning messages by entity and attribute
     */
    public ValidationResult(Map> errors, Map> warnings) {

        m_errors = errors;
        m_warnings = warnings;
    }

    /**
     * Constructor. For serialization only.

     */
    protected ValidationResult() {

        // nothing to do
    }

    /**
     * Returns all error messages by entity id and attribute.

     * 
     * @return the error messages by entity id and attribute
     */
    public Map> getErrors() {

        return m_errors;
    }

    /**
     * Returns the error messages for the given entity.

     * 
     * @param entityId the entity id
     * 
     * @return the error messages for the given entity
     */
    public Map getErrors(String entityId) {

        return m_errors != null ? m_errors.get(entityId) : null;
    }

    /**
     * Returns all warning messages by entity id and attribute.

     * 
     * @return the warning messages by entity id and attribute
     */
    public Map> getWarnings() {

        return m_warnings;
    }

    /**
     * Returns the warning messages for the given entity.

     * 
     * @param entityId the entity id
     * 
     * @return the warning messages for the given entity
     */
    public Map getWarnings(String entityId) {

        return m_warnings != null ? m_warnings.get(entityId) : null;
    }

    /**
     * Returns if there are any errors.

     * 
     * @return true if there are any errors
     */
    public boolean hasErrors() {

        return (m_errors != null) && !m_errors.isEmpty();
    }

    /**
     * Returns if the entity of the given id has errors.

     * 
     * @param entityId the entity id
     * 
     * @return true if the entity of the given id has errors
     */
    public boolean hasErrors(String entityId) {

        return (m_errors != null) && (m_errors.get(entityId) != null);
    }

    /**
     * Returns if there are any warnings.

     * 
     * @return true if there are any warnings
     */
    public boolean hasWarnings() {

        return (m_warnings != null) && !m_warnings.isEmpty();
    }

    /**
     * Returns if the entity of the given id has warnings.
     * 
     * @param entityId the entity id
     * 
     * @return true if the entity of the given id has warnings
     */
    public boolean hasWarnings(String entityId) {

        return (m_warnings != null) && (m_warnings.get(entityId) != null);
    }

}