EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

org.eclipse.persistence.eis.interactions
Class IndexedInteraction

java.lang.Object
  extended by org.eclipse.persistence.internal.databaseaccess.DatasourceCall
      extended by org.eclipse.persistence.eis.interactions.EISInteraction
          extended by org.eclipse.persistence.eis.interactions.IndexedInteraction
All Implemented Interfaces:
java.io.Serializable, java.lang.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.

See Also:
Serialized Form
Author:
James
Since:
OracleAS TopLink 10g (10.0.3)

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
CUSTOM_MODIFY, IN, INOUT, isNativeConnectionRequired, isPrepared, LITERAL, MODIFY, NO_RETURN, OUT, OUT_CURSOR, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, shouldProcessTokenInQuotes, TRANSLATION
 
Constructor Summary
IndexedInteraction()
          Default constructor.
 
Method Summary
 void addArgument(java.lang.String argumentFieldName)
          PUBLIC: Define the argument to the interaction for the index argument.
 void addArgumentValue(java.lang.Object argumentValue)
          PUBLIC: Define the argument to the interaction for the index argument.
 void addOutputArgument(java.lang.String argumentFieldName)
          PUBLIC: Define the field/argument name to be substitute for the index output argument.
 org.eclipse.persistence.internal.sessions.AbstractRecord buildRow(javax.resource.cci.Record record, EISAccessor accessor)
          Build a database row from the record returned from the interaction.
 javax.resource.cci.Record createInputRecord(EISAccessor accessor)
          Create an indexed input record for this interaction.
 java.util.Vector getArguments()
          The arguments are the values in order of occurance in the record.
 java.util.Vector getOutputArguments()
          The output arguments in order of occurance in the record.
 void setArguments(java.util.Vector arguments)
          The arguments are the values in order of occurance in the record.
 void setOutputArguments(java.util.Vector 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, appendInOut, appendLiteral, appendModify, appendOut, appendParameter, appendTranslation, areManyRowsReturned, argumentMarker, buildNewQueryMechanism, buildQueryMechanism, clone, createField, createInOutParameter, getParameters, getParameterTypes, getQuery, getQueryString, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isCursorReturned, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isReturnSet, isSQLCall, isStoredFunctionCall, isStoredProcedureCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setIsNativeConnectionRequired, setIsPrepared, setParameters, setParameterTypes, setQuery, setQueryString, setReturnType, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString, whitespace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IndexedInteraction

public IndexedInteraction()
Default constructor.

Method Detail

addArgument

public void addArgument(java.lang.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(java.lang.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(java.lang.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 java.util.Vector getArguments()
The arguments are the values in order of occurance in the record.

Overrides:
getArguments in class EISInteraction

getOutputArguments

public java.util.Vector getOutputArguments()
The output arguments in order of occurance in the record.

Overrides:
getOutputArguments in class EISInteraction

setArguments

public void setArguments(java.util.Vector arguments)
The arguments are the values in order of occurance in the record.

Overrides:
setArguments in class EISInteraction

setOutputArguments

public void setOutputArguments(java.util.Vector outputArguments)
The output arguments in order of occurance in the record.

Overrides:
setOutputArguments in class EISInteraction

createInputRecord

public javax.resource.cci.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 org.eclipse.persistence.internal.sessions.AbstractRecord buildRow(javax.resource.cci.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

EclipseLink 2.2.0, build 'v20110202-r8913' API Reference