source/mir/entity/Entity.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package  mir.entity;
  31
  32 import java.util.Map;
  33 import java.util.List;
  34
  35 import mir.storage.DatabaseExc;
  36 import mir.storage.DatabaseFailure;
  37
  38 /**
  39  * An <code>Entity</code> represents a persistent data object, typically
  40  *   stored in a database.<p>
  41  *
  42  * @version $Id: Entity.java,v 1.21.2.14 2005/08/21 17:09:18 zapata Exp $
  43  */
  44
  45 public interface Entity {
  46   /**
  47    * Sets the values of the Entity. (Only to be called by the Storage Object)
  48    *
  49    * @param aMap Map containing the new values of the Entity
  50    */
  51
  52   public void setFieldValues(Map aMap);
  53
  54   /**
  55    * Returns the primary key of the Entity.
  56    * @return String Id
  57    */
  58   public String getId();
  59
  60   /**
  61    * Defines the primary key of the Entity (only to be set by the Database)
  62    * @param id
  63    */
  64   public void setId(String id);
  65
  66   /**
  67    * Inserts Entity into the database via Database
  68    * @return Primary Key of the Entity
  69    * @exception DatabaseExc
  70    */
  71   public String insert() throws DatabaseExc;
  72
  73   /**
  74    * Saves changes of this Entity to the database
  75    * @exception DatabaseFailure
  76    */
  77   public void update() throws DatabaseFailure;
  78
  79   /**
  80    * Sets the value for a field. Issues a log message if the field name
  81    * supplied was not found in the Entity.
  82    * @param aFieldName The field name whose value has to be set
  83    * @param aValue The new value of the field
  84    * @exception DatabaseFailure
  85    */
  86   public void setFieldValue(String aFieldName, String aValue);
  87
  88   /**
  89    * Returns the field names of the Entity
  90    */
  91   public List getFieldNames() throws DatabaseFailure;
  92
  93   /**
  94    * Returns the value of a field by field name.
  95    * @param aFieldName The name of the field
  96    * @return value of the field
  97    */
  98   public String getFieldValue(String aFieldName);
  99
 100   public boolean hasFieldValue(String aFieldName);
 101
 102   /** Returns whether fieldName is a valid field name of this Entity.
 103    */
 104   public boolean hasField(String aFieldName) throws DatabaseFailure;
 105 }
 106