I_CmsWebformActionHandler.java

/*
 * File   : $Source: /alkacon/cvs/alkacon/com.alkacon.opencms.v8.formgenerator/src/com/alkacon/opencms/v8/formgenerator/I_CmsWebformActionHandler.java,v $
 * Date   : $Date: 2010/05/21 13:49:15 $
 * Version: $Revision: 1.2 $
 *
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (C) 2010 Alkacon Software (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 com.alkacon.opencms.v8.formgenerator;

import org.opencms.file.CmsObject;

/**
 * Interface to execute any action after the webform was sent. <p>
 * 
 * @author Mario Jaeger
 * 
 * @version $Revision: 1.2 $ 
 * 
 * @since 7.5.2
 */
public interface I_CmsWebformActionHandler {

    /**
     * Runs the action after the web form was sent.<p>
     * 
     * @param cmsObject the current users context
     * @param formHandler the initialized web form handler
     * 
     */
    void afterWebformAction(CmsObject cmsObject, CmsFormHandler formHandler);

    /**
     * Runs the action before the form is sent.<p>
     * 
     * Should return <code>null</code> if the performed action was successful.
     * In error cases the returned String will be used as redirect target.<p> 
     * 
     * @param cmsObject the current users context
     * @param formHandler the initialized web form handler
     * 
     * @return a link target URI inside OpenCms if an error occurred or <code>null</code> on success
     */
    String beforeWebformAction(CmsObject cmsObject, CmsFormHandler formHandler);
}