commonj.connector.runtime
Interface RecordHolder

All Superinterfaces:
Serializable

public interface RecordHolder
extends Serializable

An interface to support third party generated records. It is used to set the EIS data as the CCI Record on the generated record. It is used in the outbound J2C service invocation when the resource adapter supports the execute method with input only and in the inbound invocation. This interface is analogous to the RecordHolderDataBinding for the use with generated Records which will implement it.

Since:
1.1

Method Summary
 Record getRecord()
          Get the native representation of data as cci Record.
 void setRecord(Record aRecord)
          Set the native data on the generated record.
 

Method Detail

getRecord

Record getRecord()
                 throws DataBindingException
Get the native representation of data as cci Record. For the outbound case, the Record is then passed to the execute method of the Interaction.

For inbound invocation, the record is returned from the listener method (for example onMessage). If the resource adapter does not support InboundListener interface, the record may be the instance of the InboundNativeDataRecord.

Returns:
Native representation of the data as cci Record. The returned value may be null which indicates that there is no native data. Any error must be reported using DataBindingException.
Throws:
DataBindingException - if an error occured during execution. The cause may contain the original exception.
See Also:


setRecord

void setRecord(Record aRecord)
               throws DataBindingException
Set the native data on the generated record. In the outbound case, the Record argument is the Record returned by the input only execute.

For inbound invocation, it is the argument of the listener interface method. If the resource adapter does not support InboundListener interface, the record will be an instance of the InboundNativeDataRecord.

Parameters:
aRecord - Native representation of the data as cci Record. The argument may be null.
Throws:
DataBindingException - if an error occured during execution. The cause may contain the original exception.
See Also:
InboundNativeDataRecord