org.openmdx.base.resource.cci
Interface ExtendedRecordFactory

All Superinterfaces:

RecordFactory

All Known Implementing Classes:

OrderedRecordFactory

public interface ExtendedRecordFactory
extends RecordFactory

The ExtendedRecordFactory interface is used for creating initialized MappedRecord and IndexedRecord instances.

Method Summary

IndexedRecord	asIndexedRecord(String recordName, String recordShortDescription, Object values) Creates an IndexedRecord with the given name, description and content.
MappedRecord	asMappedRecord(String recordName, String recordShortDescription, Object[] keys, Object[] values) Creates a MappedRecord with the given name, short description and content.
IndexedRecord	createIndexedRecord(String recordName, String recordShortDescription) Creates an IndexedRecord with the given name and short description.
IndexedRecord	createIndexedRecord(String recordName, String recordShortDescription, List values) Creates an IndexedRecord with the given name, short description and content.
MappedRecord	createMappedRecord(String recordName, String recordShortDescription) Creates a MappedRecord with the given name and short description.
MappedRecord	createMappedRecord(String recordName, String recordShortDescription, List keys, List values) Creates a MappedRecord with the given name, short description and content.
MappedRecord	createMappedRecord(String recordName, String recordShortDescription, Map content) Creates a MappedRecord with the given name, short description and content.

Methods inherited from interface javax.resource.cci.RecordFactory

createIndexedRecord, createMappedRecord

Method Detail

createMappedRecord

MappedRecord createMappedRecord(String recordName,
                                String recordShortDescription)
                                throws ResourceException

Creates a MappedRecord with the given name and short description.

Parameters:

recordName - The name of the record acts as a pointer to the meta information (stored in the metadata repository) for a specific record type.

recordShortDescription - The short description of the Record; or null.

Throws:

ResourceException - Failed to create an initialized MappedRecord. Example error cases are:

• Invalid specification of record name
• Resource adapter internal error
• Failed to access metadata repository

NotSupportedException - Operation not supported

createMappedRecord

MappedRecord createMappedRecord(String recordName,
                                String recordShortDescription,
                                Map content)
                                throws ResourceException

Creates a MappedRecord with the given name, short description and content.

Parameters:

recordName - The name of the record acts as a pointer to the meta information (stored in the metadata repository) for a specific record type.

recordShortDescription - The short description of the Record; or null.

content - The content to be copied into the record instance.

Throws:

ResourceException - Failed to create an initialized MappedRecord. Example error cases are:

• Invalid specification of record name
• Resource adapter internal error
• Failed to access metadata repository

NotSupportedException - Operation not supported

createMappedRecord

MappedRecord createMappedRecord(String recordName,
                                String recordShortDescription,
                                List keys,
                                List values)
                                throws ResourceException

Creates a MappedRecord with the given name, short description and content.

Parameters:

recordName - The name of the record acts as a pointer to the meta information (stored in the metadata repository) for a specific record type.

recordShortDescription - The short description of the Record; or null.

keys - The keys of the mapped record

values - The values of the mapped record sorted according to the keys

Throws:

ResourceException - Failed to create an initialized MappedRecord. Example error cases are:

• Invalid specification of record name
• Resource adapter internal error
• Failed to access metadata repository

NotSupportedException - Operation not supported

asMappedRecord

MappedRecord asMappedRecord(String recordName,
                            String recordShortDescription,
                            Object[] keys,
                            Object[] values)
                            throws ResourceException

Creates a MappedRecord with the given name, short description and content.

The MappedRecord is backed up by the given arrays.

Parameters:

recordName - The name of the record acts as a pointer to the meta information (stored in the metadata repository) for a specific record type.

recordShortDescription - The short description of the Record; or null.

keys - The keys of the mapped record

values - The values of the mapped record sorted according to the keys

Throws:

ResourceException - Failed to create an initialized MappedRecord. Example error cases are:

• Invalid specification of record name
• Resource adapter internal error
• Failed to access metadata repository

NotSupportedException - Operation not supported

createIndexedRecord

IndexedRecord createIndexedRecord(String recordName,
                                  String recordShortDescription)
                                  throws ResourceException

Creates an IndexedRecord with the given name and short description.

Parameters:

recordName - The name of the record acts as a pointer to the meta information (stored in the metadata repository) for a specific record type.

recordShortDescription - The short description of the Record; or null.

values - The values of the indexed record.

Throws:

ResourceException - Failed to create an initialized IndexedRecord. Example error cases are:

• Invalid specification of record name
• Resource adapter internal error
• Failed to access metadata repository

NotSupportedException - Operation not supported

createIndexedRecord

IndexedRecord createIndexedRecord(String recordName,
                                  String recordShortDescription,
                                  List values)
                                  throws ResourceException

Creates an IndexedRecord with the given name, short description and content.

Parameters:

recordName - The name of the record acts as a pointer to the meta information (stored in the metadata repository) for a specific record type.

recordShortDescription - The short description of the Record; or null.

values - The values of the indexed record.

Throws:

ResourceException - Failed to create an initialized IndexedRecord. Example error cases are:

• Invalid specification of record name
• Resource adapter internal error
• Failed to access metadata repository

NotSupportedException - Operation not supported

asIndexedRecord

IndexedRecord asIndexedRecord(String recordName,
                              String recordShortDescription,
                              Object values)
                              throws ResourceException

Creates an IndexedRecord with the given name, description and content.

The Record is backed up by the given array.

Parameters:

recordName - The name of the record acts as a pointer to the meta information (stored in the metadata repository) for a specific record type.

recordShortDescription - The short description of the Record; or null.

values - The values of the indexed record represented by a List or an array of objects or primitive types.

Throws:

ResourceException - Failed to create an initialized IndexedRecord. Example error cases are:

• Invalid specification of record name
• Resource adapter internal error
• Failed to access metadata repository

NotSupportedException - Operation not supported