View Javadoc

1   /*
2    * $Id: FieldPopulator.java,v 1.3 2004/04/04 18:26:59 eelco12 Exp $
3    * $Revision: 1.3 $
4    * $Date: 2004/04/04 18:26:59 $
5    *
6    * ====================================================================
7    * Copyright (c) 2003, Open Edge B.V.
8    * All rights reserved.
9    * Redistribution and use in source and binary forms, with or without 
10   * modification, are permitted provided that the following conditions are met:
11   * Redistributions of source code must retain the above copyright notice, 
12   * this list of conditions and the following disclaimer. Redistributions 
13   * in binary form must reproduce the above copyright notice, this list of 
14   * conditions and the following disclaimer in the documentation and/or other 
15   * materials provided with the distribution. Neither the name of OpenEdge B.V. 
16   * nor the names of its contributors may be used to endorse or promote products 
17   * derived from this software without specific prior written permission.
18   * 
19   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
20   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
21   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
22   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
23   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
24   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
25   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
26   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
27   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
28   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
29   * THE POSSIBILITY OF SUCH DAMAGE.
30   */
31  package nl.openedge.baritus.population;
32  
33  import nl.openedge.baritus.FormBeanContext;
34  
35  import org.infohazard.maverick.flow.ControllerContext;
36  
37  /***
38   * A field populator knows how to populate properties from (request) parameters.
39   * Users can implement this interface to override the default population behaviour
40   * and register instances with field names.
41   * 
42   * @author Eelco Hillenius
43   */
44  public interface FieldPopulator
45  {
46  	/***
47  	 * set a property on the given form
48  	 * @param cctx maverick context
49  	 * @param formBeanContext context with instance of the form to set the property on
50  	 * @param name name of the property
51  	 * @param value unconverted value to set
52  	 * @return boolean true if the property was set successfully, false otherwise
53  	 * @throws Exception
54  	 */
55  	public boolean setProperty(
56  		ControllerContext cctx,
57  		FormBeanContext formBeanContext,
58  		String name,
59  		Object value)
60  		throws Exception;
61  		
62  }