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

public Class MappedInteraction

extends EISInteraction
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.eis.interactions.QueryStringInteraction, org.eclipse.persistence.eis.interactions.XMLInteraction
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 using Mapped records. Builds the input and output records from the arguments.
Author
James
Since
OracleAS TopLink 10g (10.0.3)

Field Summary

Modifier and TypeField and Description
protected Vector<String>
protected String
Inherited from org.eclipse.persistence.eis.interactions.EISInteraction:
argumentsfunctionNameinputRecordNameinputRowinteractionSpecoutputArgumentNamesoutputArgumentsoutputResultPathproperties

Constructor Summary

AccessConstructor and Description
public
MappedInteraction()

Default constructor.

Method Summary

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

PUBLIC: Define the argument to the interaction and the field/argument name to be substitute for it.

public void
addArgument(String parameterName, String argumentFieldName)

PUBLIC: Define the argument to the interaction and the field/argument name to be substitute for it.

public void
addArgumentValue(String parameterName, Object argumentValue)

PUBLIC: Define the argument to the interaction and the value name to be input for it.

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 a mapped input record for this interaction.
public Record
createTranslationRecord(AbstractRecord transaltionRow, EISAccessor accessor)

Create a mapped input record for this interaction.

public Vector<String>
getArgumentNames()

The argument names for the input record.

public String
getInputResultPath()

PUBLIC: The input result path defines the root key for the MappedRecord that the interaction argument is nested into.

public void
setArgumentNames(Vector<String> argumentNames)

INTERNAL: The argument names for the input record.

public void
setInputResultPath(String inputResultPath)

PUBLIC: The input result path defines the root key for the MappedRecord that the interaction argument is nested into.

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

Field Detail

argumentNamesback to summary
protected Vector<String> argumentNames
inputResultPathback to summary
protected String inputResultPath

Constructor Detail

MappedInteractionback to summary
public MappedInteraction()

Default constructor.

Method Detail

addArgumentback to summary
public void addArgument(String parameterAndArgumentFieldName)

PUBLIC: Define the argument to the interaction and the field/argument name to be substitute for it. This is only required if an input row is not used. The parameterAndArgumentFieldName is the name of the input record argument, and is the field or argument name to be used to pass to the interaction. These names are assumed to be the same, if not this method can be called with two arguments.

addArgumentback to summary
public void addArgument(String parameterName, String argumentFieldName)

PUBLIC: Define the argument to the interaction and the field/argument name to be substitute for it. This is only required if an input row is not used. The parameterName is the name of the input record argument. The argumentFieldName is the field or argument name to be used to pass to the interaction. If these names are the same (as they normally are) this method can be called with a single argument.

addArgumentValueback to summary
public void addArgumentValue(String parameterName, Object argumentValue)

PUBLIC: Define the argument to the interaction and the value name to be input for it. This is only required if an input row is not used. The parameterName is the name of the input record argument. The argumentValue is the value of the input record argument.

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.

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

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

Create a mapped input record for this interaction. Populate the data into the record from this interaction's arguments.

Annotations
@Override
createTranslationRecordback to summary
public Record createTranslationRecord(AbstractRecord transaltionRow, EISAccessor accessor)

Create a mapped input record for this interaction. Populate the data into the record from this interaction's translation row.

getArgumentNamesback to summary
public Vector<String> getArgumentNames()

The argument names for the input record.

getInputResultPathback to summary
public String getInputResultPath()

PUBLIC: The input result path defines the root key for the MappedRecord that the interaction argument is nested into. This is required for write interaction that take the row build from the mapped object and need the input to contain that row record as part of the input, instead of the entire input.

setArgumentNamesback to summary
public void setArgumentNames(Vector<String> argumentNames)

INTERNAL: The argument names for the input record.

setInputResultPathback to summary
public void setInputResultPath(String inputResultPath)

PUBLIC: The input result path defines the root key for the MappedRecord that the interaction argument is nested into. This is required for write interaction that take the row build from the mapped object and need the input to contain that row record as part of the input, instead of the entire input.