001    //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/enterprise/control/FormEvent.java $
002    /*----------------    FILE HEADER  ------------------------------------------
003    
004    This file is part of deegree.
005    Copyright (C) 2001-2008 by:
006    EXSE, Department of Geography, University of Bonn
007    http://www.giub.uni-bonn.de/deegree/
008    lat/lon GmbH
009    http://www.lat-lon.de
010    
011    This library is free software; you can redistribute it and/or
012    modify it under the terms of the GNU Lesser General Public
013    License as published by the Free Software Foundation; either
014    version 2.1 of the License, or (at your option) any later version.
015    
016    This library is distributed in the hope that it will be useful,
017    but WITHOUT ANY WARRANTY; without even the implied warranty of
018    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
019    Lesser General Public License for more details.
020    
021    You should have received a copy of the GNU Lesser General Public
022    License along with this library; if not, write to the Free Software
023    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
024    
025    Contact:
026    
027    Andreas Poth
028    lat/lon GmbH
029    Aennchenstr. 19
030    53115 Bonn
031    Germany
032    E-Mail: poth@lat-lon.de
033    
034    Prof. Dr. Klaus Greve
035    Department of Geography
036    University of Bonn
037    Meckenheimer Allee 166
038    53115 Bonn
039    Germany
040    E-Mail: greve@giub.uni-bonn.de
041    
042                     
043     ---------------------------------------------------------------------------*/
044    
045    // $Id: FormEvent.java 9338 2007-12-27 12:31:31Z apoth $
046    package org.deegree.enterprise.control;
047    
048    import java.util.Properties;
049    
050    
051    /**
052     * Represents a HTML-Form event created by the webbrowser.
053     * Encapsulates all nessesary information.
054     *
055     * @version $Revision: 9338 $
056     *
057     * @author $Author: apoth $
058     */
059    public interface FormEvent {
060        /**
061         * Returns the list of parameter.
062         */
063        public Properties getParameter();
064        
065        /**
066         * Returns the document path.
067         */
068        public String getDocumentPath();
069    
070        /**
071         * Returns an object containig information about the user.
072         */
073        public RequestUser getRequestUser();
074    
075        /**
076         * Returns the source object. Normaly the an HTTPRequest object.
077         */
078        public Object getSource();
079    }