Java 2 Platform EE v1.3: Interface RecordFactory - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.resource.cci
Interface RecordFactory

public interface RecordFactory

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.

Since:: 0.8
See Also:: IndexedRecord, MappedRecord

Method Summary

IndexedRecord createIndexedRecord(java.lang.String recordName)
Creates a IndexedRecord.

MappedRecord createMappedRecord(java.lang.String recordName)
Creates a MappedRecord.

Method Detail

createMappedRecord

public MappedRecord createMappedRecord(java.lang.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 - Name of the Record

Returns:

MappedRecord

Throws:

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

createIndexedRecord

public IndexedRecord createIndexedRecord(java.lang.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.