JavaEE API 8.0.1 · javax.resource.cci.Record

The javax.resource.cci.Record interface is the base interface for the representation of an input or output to the execute methods defined on an Interaction.

The Record interface can be extended to form a one of the following representations:

MappedRecord: A key-value pair based collection represents a record. This interface is based on the java.util.Map
IndexedRecord:An ordered and indexed collection represents a record. This interface is based on the java.util.List.
JavaBean based representation of an EIS abstraction: An example is a custom record generated to represent a purchase order in an ERP system.
javax.resource.cci.ResultSet: This interface extends both java.sql.ResultSet and javax.resource.cci.Record. A ResultSet represents tabular data.

A MappedRecord or IndexedRecord can contain another Record. This means that MappedRecord and IndexedRecord can be used to create a hierarchical structure of any arbitrary depth. A basic Java type is used as the leaf element of a hierarchical structure represented by a MappedRecord or IndexedRecord.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: a clone of this instance. clone() Creates and returns a copy of this object.
public boolean	Returns: true if two instances are equal equals(Object other) Check if this instance is equal to another Record.
public String	Returns: String representing name of the Record getRecordName() Gets the name of the Record.
public String	Returns: String representing a short description of the Record getRecordShortDescription() Gets a short description string for the Record.
public int	Returns: hash code hashCode() Returns the hash code for the Record instance.
public void	setRecordName(String Name of the Record name) Sets the name of the Record.
public void	setRecordShortDescription(String Description of the Record description) Sets a short description string for the Record.

Method Detail

clone	back to summary
public Object clone() throws CloneNotSupportedException Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. Returns:Object a clone of this instance. Exceptions CloneNotSupportedException: If the object's class does not support the Cloneable interface Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

clone

back to summary

public Object clone() throws CloneNotSupportedException

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object.

Returns:Object

a clone of this instance.

Exceptions

CloneNotSupportedException:: If the object's class does not support the Cloneable interface Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

equals	back to summary
public boolean equals(Object other) Check if this instance is equal to another Record. Returns:boolean true if two instances are equal

equals

back to summary

public boolean equals(Object other)

Check if this instance is equal to another Record.

Returns:boolean: true if two instances are equal

getRecordName	back to summary
public String getRecordName() Gets the name of the Record. Returns:String String representing name of the Record

getRecordName

back to summary

public String getRecordName()

Gets the name of the Record.

Returns:String: String representing name of the Record

getRecordShortDescription	back to summary
public String getRecordShortDescription() Gets a short description string for the Record. This property is used primarily by application development tools. Returns:String String representing a short description of the Record

getRecordShortDescription

back to summary

public String getRecordShortDescription()

Gets a short description string for the Record. This property is used primarily by application development tools.

Returns:String: String representing a short description of the Record

hashCode	back to summary
public int hashCode() Returns the hash code for the Record instance. Returns:int hash code

hashCode

back to summary

public int hashCode()

Returns the hash code for the Record instance.

Returns:int: hash code

setRecordName	back to summary
public void setRecordName(String name) Sets the name of the Record. Parameters name:String Name of the Record

setRecordName

back to summary

public void setRecordName(String name)

Sets the name of the Record.

Parameters

name:String: Name of the Record

setRecordShortDescription	back to summary
public void setRecordShortDescription(String description) Sets a short description string for the Record. This property is used primarily by application development tools. Parameters description:String Description of the Record

setRecordShortDescription

back to summary

public void setRecordShortDescription(String description)

Sets a short description string for the Record. This property is used primarily by application development tools.

Parameters

description:String: Description of the Record

public Interface Record

Method Summary

Method Detail