source/mir/entity/Entity.java

   1 /*
   2  * Copyright (C) 2005 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  * You must obey the GNU General Public License in all respects for all of the code used
  23  * other than the above mentioned libraries.  If you modify this file, you may extend this
  24  * exception to your version of the file, but you are not obligated to do so.
  25  * If you do not wish to do so, delete this exception statement from your version.
  26  */
  27 package  mir.entity;
  28
  29 import java.util.Map;
  30 import java.util.List;
  31
  32 import mir.storage.DatabaseExc;
  33 import mir.storage.DatabaseFailure;
  34
  35 /**
  36  * An <code>Entity</code> represents a persistent data object, typically
  37  *   stored in a database.<p>
  38  *
  39  * @version $Id: Entity.java,v 1.24 2007/04/08 21:46:44 idfx Exp $
  40  */
  41
  42 public interface Entity {
  43   /**
  44    * Sets the values of the Entity. (Only to be called by the Storage Object)
  45    *
  46    * @param aMap Map containing the new values of the Entity
  47    */
  48
  49   public void setFieldValues(Map aMap);
  50
  51   /**
  52    * Returns the primary key of the Entity.
  53    * @return String Id
  54    */
  55   public String getId();
  56
  57   /**
  58    * Defines the primary key of the Entity (only to be set by the Database)
  59    * @param id
  60    */
  61   public void setId(String id);
  62
  63   /**
  64    * Inserts Entity into the database via Database
  65    * @return Primary Key of the Entity
  66    * @exception DatabaseExc
  67    */
  68   public String insert() throws DatabaseExc;
  69
  70   /**
  71    * Saves changes of this Entity to the database
  72    * @exception DatabaseFailure
  73    */
  74   public void update() throws DatabaseFailure;
  75
  76   /**
  77    * Sets the value for a field. Issues a log message if the field name
  78    * supplied was not found in the Entity.
  79    * @param aFieldName The field name whose value has to be set
  80    * @param aValue The new value of the field
  81    * @exception DatabaseFailure
  82    */
  83   public void setFieldValue(String aFieldName, String aValue);
  84
  85   /**
  86    * Returns the field names of the Entity
  87    */
  88   public List getFieldNames() throws DatabaseFailure;
  89
  90   /**
  91    * Returns the value of a field by field name.
  92    * @param aFieldName The name of the field
  93    * @return value of the field
  94    */
  95   public String getFieldValue(String aFieldName);
  96
  97   public boolean hasFieldValue(String aFieldName);
  98
  99   /** Returns whether fieldName is a valid field name of this Entity.
 100    */
 101   public boolean hasField(String aFieldName) throws DatabaseFailure;
 102 }
 103