001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (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.client.ui.input.form;
029
030import java.util.Map;
031import java.util.Set;
032
033/**
034 * This is an interface for classes which process submitted form data.<p>
035 */
036public interface I_CmsFormSubmitHandler {
037
038    /**
039     * The method which should be called when a {@link CmsForm} is submitted.<p>
040     *
041     * The map passed as a parameter will contain key-value pairs where the key is the
042     * name of the field and the value is the value obtained from the field. It is explicitly
043     * allowed that the value is null; this means that the property is set to 'default'.
044     *
045     * @param form the form
046     * @param fieldValues a map of field values
047     * @param editedFields the fields which have been edited
048     */
049    void onSubmitForm(CmsForm form, Map<String, String> fieldValues, Set<String> editedFields);
050
051}