001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.gwt;
029
030import org.opencms.file.CmsObject;
031import org.opencms.gwt.shared.CmsValidationQuery;
032import org.opencms.gwt.shared.CmsValidationResult;
033
034import java.util.Map;
035
036/**
037 * Interface for handling the server-side validation of a whole form.<p>
038 *
039 * @since 8.0.0
040 */
041public interface I_CmsFormValidator {
042
043    /**
044     * Validates the form and returns the validation result.<p>
045     *
046     * Implementations of this interface may or may not use the validators in the validation queries passed as
047     * an argument.<p>
048     *
049     * @param cms the CMS context
050     * @param queries the validation queries for the form fields, indexed by form field key
051     * @param values the form field values
052     * @param config the configuration for the form validator
053     *
054     * @return a map of the validation results, indexed by form field key
055     *
056     * @throws Exception if something goes wrong
057     */
058    Map<String, CmsValidationResult> validate(
059        CmsObject cms,
060        Map<String, CmsValidationQuery> queries,
061        Map<String, String> values,
062        String config) throws Exception;
063
064}