001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/framework/trigger/Trigger.java $
002    /*----------------------------------------------------------------------------
003     This file is part of deegree, http://deegree.org/
004     Copyright (C) 2001-2009 by:
005       Department of Geography, University of Bonn
006     and
007       lat/lon GmbH
008    
009     This library is free software; you can redistribute it and/or modify it under
010     the terms of the GNU Lesser General Public License as published by the Free
011     Software Foundation; either version 2.1 of the License, or (at your option)
012     any later version.
013     This library is distributed in the hope that it will be useful, but WITHOUT
014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016     details.
017     You should have received a copy of the GNU Lesser General Public License
018     along with this library; if not, write to the Free Software Foundation, Inc.,
019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020    
021     Contact information:
022    
023     lat/lon GmbH
024     Aennchenstr. 19, 53177 Bonn
025     Germany
026     http://lat-lon.de/
027    
028     Department of Geography, University of Bonn
029     Prof. Dr. Klaus Greve
030     Postfach 1147, 53001 Bonn
031     Germany
032     http://www.geographie.uni-bonn.de/deegree/
033    
034     e-mail: info@deegree.org
035    ----------------------------------------------------------------------------*/
036    package org.deegree.framework.trigger;
037    
038    /**
039     *
040     *
041     *
042     * @version $Revision: 18195 $
043     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
044     * @author last edited by: $Author: mschneider $
045     *
046     * @version 1.0. $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
047     *
048     * @since 2.0
049     */
050    public interface Trigger {
051    
052        /**
053         * performs the action(s) defined by a concrete trigger. The returned value must have the same
054         * structure as the passed parameter. A trigger may changes the values of the passed
055         * parameter(s) but do not change their type or structure
056         *
057         * @param caller
058         * @param values
059         */
060        public Object[] doTrigger( Object caller, Object... values );
061    
062        /**
063         * returns the name of the Trigger. The name starts with the name of the class Trigger is
064         * assigend to followed by the method from where it is called followed by its 'specific' name;
065         * e.g.<br>
066         * org.deegree.enterprise.servlet.OGCServletController.doService.MyTrigger
067         *
068         * @return the name of the Trigger.
069         */
070        public String getName();
071    
072        /**
073         * sets the name of a Trigger
074         *
075         * @param name
076         */
077        public void setName( String name );
078    
079    }