Package org.eclipse.persistence.eis.interactions

Class 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)

    • Nested Class Summary

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

        org.eclipse.persistence.internal.databaseaccess.DatasourceCall.ParameterType

    • Constructor Summary

      Constructors 
      Constructor Description
      IndexedInteraction()
      Default constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.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 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