/*
- * Copyright (C) 2001, 2002 The Mir-coders group
+ * Copyright (C) 2005 The Mir-coders group
*
* This file is part of Mir.
*
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* In addition, as a special exception, The Mir-coders gives permission to link
- * the code of this program with any library licensed under the Apache Software License,
- * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
- * (or with modified versions of the above that use the same license as the above),
- * and distribute linked combinations including the two. You must obey the
- * GNU General Public License in all respects for all of the code used other than
- * the above mentioned libraries. If you modify this file, you may extend this
+ * the code of this program with any library licensed under the Apache Software License.
+ * You must obey the GNU General Public License in all respects for all of the code used
+ * other than the above mentioned libraries. If you modify this file, you may extend this
* exception to your version of the file, but you are not obligated to do so.
* If you do not wish to do so, delete this exception statement from your version.
*/
package mir.entity;
-import java.util.List;
import java.util.Map;
+import java.util.List;
-import mir.storage.StorageObjectExc;
-import mir.storage.StorageObjectFailure;
+import mir.storage.DatabaseExc;
+import mir.storage.DatabaseFailure;
/**
* An <code>Entity</code> represents a persistent data object, typically
* stored in a database.<p>
*
- * @version $Id: Entity.java,v 1.21.2.11 2005/02/10 16:22:30 rhindes Exp $
+ * @version $Id: Entity.java,v 1.21.2.15 2005/12/24 11:43:34 zapata Exp $
*/
public interface Entity {
public void setId(String id);
/**
- * Insers Entity into the database via Database
+ * Inserts Entity into the database via Database
* @return Primary Key of the Entity
- * @exception StorageObjectExc
+ * @exception DatabaseExc
*/
- public String insert() throws StorageObjectExc;
+ public String insert() throws DatabaseExc;
/**
* Saves changes of this Entity to the database
- * @exception StorageObjectFailure
+ * @exception DatabaseFailure
*/
- public void update() throws StorageObjectFailure;
+ public void update() throws DatabaseFailure;
/**
* Sets the value for a field. Issues a log message if the field name
* supplied was not found in the Entity.
- * @param theProp The field name whose value has to be set
- * @param theValue The new value of the field
- * @exception StorageObjectFailure
+ * @param aFieldName The field name whose value has to be set
+ * @param aValue The new value of the field
+ * @exception DatabaseFailure
*/
- public void setFieldValue(String theProp, String theValue);
+ public void setFieldValue(String aFieldName, String aValue);
/**
* Returns the field names of the Entity
*/
- public List getFieldNames() throws StorageObjectFailure;
+ public List getFieldNames() throws DatabaseFailure;
/**
* Returns the value of a field by field name.
- * @param field The name of the field
+ * @param aFieldName The name of the field
* @return value of the field
*/
- public String getFieldValue(String field);
+ public String getFieldValue(String aFieldName);
- public boolean hasFieldValue(String field);
+ public boolean hasFieldValue(String aFieldName);
/** Returns whether fieldName is a valid field name of this Entity.
*/
- public boolean hasField(String aFieldName) throws StorageObjectFailure;
+ public boolean hasField(String aFieldName) throws DatabaseFailure;
}