View Javadoc

1   /* (c) Copyright 2003 Caleigo AB, All rights reserved. 
2    * 
3    * This library is free software; you can redistribute it and/or
4    * modify it under the terms of the GNU Lesser General Public
5    * License as published by the Free Software Foundation; either
6    * version 2.1 of the License, or (at your option) any later version.
7    * 
8    * This library is distributed in the hope that it will be useful,
9    * but WITHOUT ANY WARRANTY; without even the implied warranty of
10   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11   * Lesser General Public License for more details.
12   * 
13   * You should have received a copy of the GNU Lesser General Public
14   * License along with this library; if not, write to the Free Software
15   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16   *  
17   */
18  
19  package org.caleigo.core;
20  
21  /*** Interface for calculated fields. The two action methods (getFieldDataFrom
22   * and setFieldDataTo) are called by entity-objects when one wants to
23   * get/set data for a field that implements ICalculatedFieldDescriptor.
24   *
25   * @author  Dennis Zikovic
26   * @version 1.00
27   * 
28   *//* 
29   *
30   * WHEN        WHO               WHY & WHAT
31   * -----------------------------------------------------------------------------
32   * 2001-07-16  Dennis Zikovic    Creation
33   */
34  public interface ICalculatedFieldDescriptor extends IFieldDescriptor 
35  {
36      // Action methods ----------------------------------------------------------
37      public Object getFieldDataFrom(IEntity entity);
38      public void setFieldDataTo(IEntity entity, Object data);
39      
40      // Access methods ----------------------------------------------------------
41      
42      /*** should Returns true if the descriptor is "valid for" = can be a part 
43       * of and calculate its value based on the data defined by the submited 
44       * entity descriptor.
45       */
46      public boolean isValidFor(IEntityDescriptor entityDescriptor);
47      
48      /*** Should return an array of the field descriptors required for the 
49       * "calculation" of the descriptors value.
50       */
51      public IFieldDescriptor[] getRequiredFields();
52  }