Top Description Fields Constructors Methods
org.eclipse.persistence.eis.interactions

public Class IndexedInteraction

extends EISInteraction
Class Inheritance
Imports
java.util.*, jakarta.resource.*, jakarta.resource.cci.*, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.sessions.AbstractRecord, org.eclipse.persistence.sessions.DatabaseRecord, org.eclipse.persistence.eis.*

Defines the specification for a call to a JCA interaction that uses indexed records. Builds the input and output records from the arguments.
Author
James
Since
OracleAS TopLink 10g (10.0.3)

Field Summary

Inherited from org.eclipse.persistence.eis.interactions.EISInteraction:
argumentsfunctionNameinputRecordNameinputRowinteractionSpecoutputArgumentNamesoutputArgumentsoutputResultPathproperties

Constructor Summary

AccessConstructor and Description
public
IndexedInteraction()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public void
addArgument(String argumentFieldName)

PUBLIC: Define the argument to the interaction for the index argument.

public void
addArgumentValue(Object argumentValue)

PUBLIC: Define the argument to the interaction for the index argument.

public void
addOutputArgument(String argumentFieldName)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.addOutputArgument.

PUBLIC: Define the field/argument name to be substitute for the index output argument.
public AbstractRecord
buildRow(Record record, EISAccessor accessor)

Implements abstract org.eclipse.persistence.eis.interactions.EISInteraction.buildRow.

Build a database row from the record returned from the interaction.
public Record
createInputRecord(EISAccessor accessor)

Implements abstract org.eclipse.persistence.eis.interactions.EISInteraction.createInputRecord.

Create an indexed input record for this interaction.
public Vector<E>
getArguments()

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.getArguments.

The arguments are the values in order of occurance in the record.
public Vector<DatabaseField>
getOutputArguments()

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.getOutputArguments.

The output arguments in order of occurance in the record.
public void
setArguments(Vector<E> arguments)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.setArguments.

The arguments are the values in order of occurance in the record.
public void
setOutputArguments(Vector<DatabaseField> outputArguments)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.setOutputArguments.

The output arguments in order of occurance in the record.
Inherited from org.eclipse.persistence.eis.interactions.EISInteraction:
addOutputArgumentbuildRowscreateRecordElementgetFunctionNamegetInputRecordNamegetInputRowgetInteractionSpecgetLogStringgetOutputArgumentNamesgetOutputResultPathgetPropertiesgetPropertyhasArgumentshasOutputArgumentsisEISInteractionpreparesetFunctionNamesetInputRecordNamesetInputRowsetInteractionSpecsetOutputArgumentNamessetOutputResultPathsetPropertiessetPropertytoStringtranslate

Constructor Detail

IndexedInteractionback to summary
public IndexedInteraction()

Default constructor.

Method Detail

addArgumentback to summary
public void addArgument(String argumentFieldName)

PUBLIC: Define the argument to the interaction for the index argument. This must be called in the order of the arguments in the input indexed record. The argumentFieldName is the field or argument name in the descriptor that maps to the indexed value.

addArgumentValueback to summary
public void addArgumentValue(Object argumentValue)

PUBLIC: Define the argument to the interaction for the index argument. This must be called in the order of the arguments in the input indexed record. The argumentValue is the value of the argument to be used to pass to the interaction.

addOutputArgumentback to summary
public void addOutputArgument(String argumentFieldName)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.addOutputArgument.

PUBLIC: Define the field/argument name to be substitute for the index output argument. This must be called in the order of the output arguments in the result indexed record. The argumentFieldName is the field or argument name in the descriptor that maps to the indexed value.

Annotations
@Override
buildRowback to summary
public AbstractRecord buildRow(Record record, EISAccessor accessor)

Implements abstract org.eclipse.persistence.eis.interactions.EISInteraction.buildRow.

Build a database row from the record returned from the interaction. Also handles MappedRecords for case of input being indexed but mapped ouput.

Annotations
@Override
createInputRecordback to summary
public Record createInputRecord(EISAccessor accessor)

Implements abstract org.eclipse.persistence.eis.interactions.EISInteraction.createInputRecord.

Create an indexed input record for this interaction. Populate the data into the record from this interaction's arguments.

Annotations
@Override
getArgumentsback to summary
public Vector<E> getArguments()

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.getArguments.

The arguments are the values in order of occurance in the record.

Annotations
@Override
getOutputArgumentsback to summary
public Vector<DatabaseField> getOutputArguments()

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.getOutputArguments.

The output arguments in order of occurance in the record.

Annotations
@Override
setArgumentsback to summary
public void setArguments(Vector<E> arguments)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.setArguments.

The arguments are the values in order of occurance in the record.

Annotations
@Override
setOutputArgumentsback to summary
public void setOutputArguments(Vector<DatabaseField> outputArguments)

Overrides org.eclipse.persistence.eis.interactions.EISInteraction.setOutputArguments.

The output arguments in order of occurance in the record.

Annotations
@Override