Top Description Methods
jakarta.resource.cci

public Interface RecordFactory

Imports
jakarta.resource.ResourceException, .NotSupportedException
The RecordFactory interface is used for creating MappedRecord and IndexedRecord instances. Note that the RecordFactory is only used for creation of generic record instances. A CCI implementation provides an implementation class for the RecordFactory interface.
Author
Rahul Sharma
Since
0.8
See Also
jakarta.resource.cci.IndexedRecord, jakarta.resource.cci.MappedRecord

Method Summary

Modifier and TypeMethod and Description
public <E> IndexedRecord<E>

Returns:

IndexedRecord
createIndexedRecord(String
Name of the Record
recordName)

Creates a IndexedRecord.

public <K, V> MappedRecord<K, V>

Returns:

MappedRecord
createMappedRecord(String
Name of the Record
recordName)

Creates a MappedRecord.

Method Detail

createIndexedRecordback to summary
public <E> IndexedRecord<E> createIndexedRecord(String recordName) throws ResourceException

Creates a IndexedRecord. The method takes the name of the record that is to be created by the RecordFactory. The name of the record acts as a pointer to the meta information (stored in the metadata repository) for a specific record type.

Parameters
recordName:String

Name of the Record

Returns:IndexedRecord<E>

IndexedRecord

Exceptions
ResourceException:
Failed to create an IndexedRecord. Example error cases are:
  • Invalid specification of record name
  • Resource adapter internal error
  • Failed to access metadata repository
NotSupportedException:
Operation not supported
createMappedRecordback to summary
public <K, V> MappedRecord<K, V> createMappedRecord(String recordName) throws ResourceException

Creates a MappedRecord. The method takes the name of the record that is to be created by the RecordFactory. The name of the record acts as a pointer to the meta information (stored in the metadata repository) for a specific record type.

Parameters
recordName:String

Name of the Record

Returns:MappedRecord<K, V>

MappedRecord

Exceptions
ResourceException:
Failed to create a MappedRecord. Example error cases are:
  • Invalid specification of record name
  • Resource adapter internal error
  • Failed to access metadata repository
NotSupportedException:
Operation not supported