01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.resource.cci;
23:
24: import java.io.Serializable;
25:
26: /**
27: * The Record interface is the base interface for representing input and output
28: * for an Interaction.
29: *
30: * A Record can be extended in several ways:
31: * <ul>
32: * <li>MappedRecord based on a Map
33: * <li>IndexedRecord based on a List
34: * <li>ResultSet based on a java.sql.ResultSet
35: * <li>Arbitrary JavaBean
36: * </ul>
37: *
38: * Both MappedRecord and IndexedRecord support heirarchical structures of
39: * Records with Records within Records.
40: */
41: public interface Record extends Cloneable, Serializable {
42: /**
43: * Creae a copy of this Record
44: */
45: public Object clone() throws CloneNotSupportedException;
46:
47: /**
48: * Compare two Records for equality
49: */
50: public boolean equals(Object other);
51:
52: /*
53: * Return a hashcode for this Record
54: */
55: public int hashCode();
56:
57: /**
58: * Get the name of this Record.
59: */
60: public String getRecordName();
61:
62: /**
63: * Set the name of this Record.
64: */
65: public void setRecordName(String name);
66:
67: /**
68: * Get the short description of this Record
69: */
70: public String getRecordShortDescription();
71:
72: /**
73: * Set the short description of this Record
74: */
75: public void setRecordShortDescription(String description);
76: }
|