Module org.eclipse.persistence.core

Package org.eclipse.persistence.eis.interactions

Class IndexedInteraction

java.lang.Object

org.eclipse.persistence.internal.databaseaccess.DatasourceCall

org.eclipse.persistence.eis.interactions.EISInteraction

org.eclipse.persistence.eis.interactions.IndexedInteraction

All Implemented Interfaces:

Serializable, Cloneable, Call

public class IndexedInteraction
extends EISInteraction

Defines the specification for a call to a JCA interaction that uses indexed records. Builds the input and output records from the arguments.

Since:

OracleAS TopLink 10g (10.0.3)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

DatasourceCall.ParameterType

Field Summary

Fields inherited from class org.eclipse.persistence.eis.interactions.EISInteraction

arguments, functionName, inputRecordName, inputRow, interactionSpec, outputArgumentNames, outputArguments, outputResultPath, properties

Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

EXECUTE_UPDATE, isNativeConnectionRequired, isPrepared, NO_RETURN, outputCursors, parameterBindings, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, shouldProcessTokenInQuotes, usesBinding

Constructor Summary

Constructors

Constructor	Description
IndexedInteraction()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addArgument(String argumentFieldName)	PUBLIC: Define the argument to the interaction for the index argument.
void	addArgumentValue(Object argumentValue)	PUBLIC: Define the argument to the interaction for the index argument.
void	addOutputArgument(String argumentFieldName)	PUBLIC: Define the field/argument name to be substitute for the index output argument.
AbstractRecord	buildRow(Record record, EISAccessor accessor)	Build a database row from the record returned from the interaction.
Record	createInputRecord(EISAccessor accessor)	Create an indexed input record for this interaction.
Vector	getArguments()	The arguments are the values in order of occurance in the record.
Vector<DatabaseField>	getOutputArguments()	The output arguments in order of occurance in the record.
void	setArguments(Vector arguments)	The arguments are the values in order of occurance in the record.
void	setOutputArguments(Vector<DatabaseField> outputArguments)	The output arguments in order of occurance in the record.

Methods inherited from class org.eclipse.persistence.eis.interactions.EISInteraction

addOutputArgument, buildRows, createRecordElement, getFunctionName, getInputRecordName, getInputRow, getInteractionSpec, getLogString, getOutputArgumentNames, getOutputResultPath, getProperties, getProperty, hasArguments, hasOutputArguments, isEISInteraction, prepare, setFunctionName, setInputRecordName, setInputRow, setInteractionSpec, setOutputArgumentNames, setOutputResultPath, setProperties, setProperty, toString, translate

Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

appendIn, appendIn, appendIn, appendInOut, appendInOut, appendInOut, appendInOut, appendInOut, appendLiteral, appendLiteral, appendLiteral, appendModify, appendModify, appendModify, appendOut, appendOut, appendOut, appendOutCursor, appendOutCursor, appendParameter, appendTranslation, appendTranslation, appendTranslation, areManyRowsReturned, argumentMarker, buildNewQueryMechanism, buildQueryMechanism, clone, createField, createInOutParameter, getOutputCursors, getParameterBindings, getParameters, getParameterTypes, getQuery, getQueryString, getReturnType, getValueForInOutParameter, getValueForInParameter, hasOutputCursors, hasParameters, isCursorReturned, isExecuteUpdate, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isReturnSet, isSQLCall, isStoredFunctionCall, isStoredPLSQLFunctionCall, isStoredPLSQLProcedureCall, isStoredProcedureCall, isUsesBindingSet, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, setIsNativeConnectionRequired, setIsPrepared, setParameterBindings, setParameters, setParameterTypes, setQuery, setQueryString, setReturnType, setUsesBinding, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString, translateQueryStringAndBindParameters, translateQueryStringForParameterizedIN, usesBinding, usesBinding, usesBinding, whitespace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

IndexedInteraction

public IndexedInteraction()

Default constructor.

Method Details

addArgument

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.

addArgumentValue

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.

addOutputArgument

public void addOutputArgument(String argumentFieldName)

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.

Overrides:

addOutputArgument in class EISInteraction

getArguments

public Vector getArguments()

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

Overrides:

getArguments in class EISInteraction

getOutputArguments

public Vector<DatabaseField> getOutputArguments()

The output arguments in order of occurance in the record.

Overrides:

getOutputArguments in class EISInteraction

setArguments

public void setArguments(Vector arguments)

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

Overrides:

setArguments in class EISInteraction

setOutputArguments

public void setOutputArguments(Vector<DatabaseField> outputArguments)

The output arguments in order of occurance in the record.

Overrides:

setOutputArguments in class EISInteraction

createInputRecord

public Record createInputRecord(EISAccessor accessor)

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

Specified by:

createInputRecord in class EISInteraction

buildRow

public AbstractRecord buildRow(Record record,
 EISAccessor accessor)

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

Specified by:

buildRow in class EISInteraction