1. /*

  2.  * Copyright 2002 Sun Microsystems, Inc. All rights reserved.

  3.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  4.  */

  5. package javax.resource.cci;

  6. 

  7. 

  8. /** The <code>javax.resource.cci.Record</code> interface is the base 

  9.  *  interface for the representation of an input or output to the 

  10.  *  execute methods defined on an Interaction.

  11.  *  

  12.  *  <p>The Record interface can be extended to form a one of the 

  13.  *  following representations:

  14.  *  <UL>

  15.  *     <LI> MappedRecord: A key-value pair based collection represents

  16.  *          a record. This interface is based on the <code>java.util.Map</code>

  17.  *     <LI> IndexedRecord:An ordered and indexed collection represents 

  18.  *          a record. This interface is based on the <code>java.util.List</code>.

  19.  *     <LI> JavaBean based representation of an EIS abstraction: An 

  20.  *          example is a custom record generated to represent a purchase 

  21.  *          order in an ERP system.

  22.  *     <LI> <code>javax.resource.cci.ResultSet</code>: This interface 

  23.  *          extends both <code>java.sql.ResultSet</code> and <code>

  24.  *          javax.resource.cci.Record</code>. A ResultSet

  25.  *          represents tabular data.

  26.  *  </UL> 

  27.  *

  28.  *  <p>A MappedRecord or IndexedRecord can contain another Record. This 

  29.  *  means that MappedRecord and IndexedRecord can be used to create 

  30.  *  a hierarchical structure of any arbitrary depth. A basic Java 

  31.  *  type is used as the leaf element of a hierarchical structure 

  32.  *  represented by a MappedRecord or IndexedRecord.

  33.  *

  34.  *  @author  Rahul Sharma

  35.  *  @version 0.8

  36.  *  @see     javax.resource.cci.Interaction

  37.  *  @see     java.sql.ResultSet

  38. **/    

  39. public interface Record extends java.lang.Cloneable, java.io.Serializable {

  40.  

  41.   /** Gets the name of the Record.

  42.    *  

  43.    *  @return  String representing name of the Record

  44.   **/

  45.   public

  46.   String getRecordName();

  47.   

  48.   /** Sets the name of the Record.

  49.    *  

  50.    *  @param   name           Name of the Record

  51.   **/

  52.   public

  53.   void setRecordName(String name);

  54.   

  55.   /** Sets a short description string for the Record. This property

  56.    *  is used primarily by application development tools.

  57.    *

  58.    *  @param   description    Description of the Record

  59.   **/

  60.   public

  61.   void setRecordShortDescription(String description);

  62. 

  63.   /** Gets a short description string for the Record. This property

  64.    *  is used primarily by application development tools.

  65.    *

  66.    *  @return  String representing a short description of the Record

  67.   **/

  68.   public

  69.   String getRecordShortDescription();

  70. 

  71.   /** Check if this instance is equal to another Record.

  72.    *

  73.    *  @return  true if two instances are equal

  74.   **/

  75.   public

  76.   boolean equals(Object other);

  77. 

  78. 

  79.   /** Returns the hash code for the Record instance.

  80.    * 

  81.    *  @return  hash code

  82.   **/

  83.   public

  84.   int hashCode();

  85. 

  86.   /** Creates and returns a copy of this object. The precise 

  87.    *  meaning of "copy" may depend on the class of the object.

  88.    *

  89.    *  @returns a clone of this instance.

  90.    *  @throws  CloneNotSupportedException 

  91.    *           If the object's class does not support the 

  92.    *           Cloneable interface Subclasses that override the 

  93.    *           clone method can also throw this exception to 

  94.    *           indicate that an instance cannot be cloned.

  95.   **/

  96.   public

  97.   Object clone() throws CloneNotSupportedException;

  98. 

  99. }