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.client.ui.input.form;
029
030/**
031 * The interface for objects which should be notified when a {@link CmsForm} is successfully submitted.<p>
032 *
033 * @since 8.0.0
034 */
035public interface I_CmsFormHandler {
036
037    /**
038     * Returns true if properties are currently being submitted.<p>
039     *
040     * @return true if properties are being submitted
041     */
042    boolean isSubmitting();
043
044    /**
045     * This method is called when the validation triggered by an attempt to submit the form has finished.<p>
046     *
047     * @param form the form
048     * @param ok the validation result
049     */
050    void onSubmitValidationResult(CmsForm form, boolean ok);
051
052    /**
053     * This method is called when the normal validation triggered by changing fields has finished.<p>
054     *
055     * @param form the form
056     * @param ok the validation result
057     */
058    void onValidationResult(CmsForm form, boolean ok);
059
060}