Package org.eclipse.persistence.platform.database.oracle.plsql

Class PLSQLStoredProcedureCall

  • All Implemented Interfaces:
    Serializable, Cloneable, Call
    Direct Known Subclasses:
    PLSQLStoredFunctionCall
    public class PLSQLStoredProcedureCall
extends StoredProcedureCall
    Purpose: Generates an Anonymous PL/SQL block to invoke the specified Stored Procedure with arguments that may or may not have JDBC equivalents. This handles conversion of PLSQL Record and Table types into SQL ARRAY (VARRAY) and STRUCT (OBJECT TYPE). It also handles conversion of flat PLSQL Record types and PLSQL BOOLEAN and other basic types.
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall

        FIRSTRESULT_FIELD, MAXROW_FIELD

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

        CUSTOM_MODIFY, IN, INLINE, INOUT, LITERAL, MODIFY, OUT, OUT_CURSOR, TRANSLATION

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addNamedArgument​(String procedureParameterAndArgumentFieldName)
      PUBLIC: Define the argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedArgument​(String procedureParameterName, String argumentFieldName)
      PUBLIC: Define the argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedArgument​(String procedureParameterName, String argumentFieldName, int type)
      PUBLIC: Define the input argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedArgument​(String procedureParameterName, String argumentFieldName, int type, String typeName)
      PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedArgument​(String procedureParameterName, org.eclipse.persistence.internal.helper.DatabaseType databaseType)
      PUBLIC: Add a named IN argument to the stored procedure.
      void addNamedArgument​(String procedureParameterName, org.eclipse.persistence.internal.helper.DatabaseType databaseType, int length)
      PUBLIC: Add a named IN argument to the stored procedure.
      void addNamedArgument​(String procedureParameterName, org.eclipse.persistence.internal.helper.DatabaseType databaseType, int precision, int scale)
      PUBLIC: Add a named IN argument to the stored procedure.
      void addNamedArgumentValue​(String procedureParameterName, Object argumentValue)
      PUBLIC: Define the argument to the stored procedure and the value to be substitute for it.
      void addNamedInOutputArgument​(String procedureParameterAndArgumentFieldName)
      PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
      void addNamedInOutputArgument​(String procedureParameterName, String argumentFieldName)
      PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
      void addNamedInOutputArgument​(String procedureParameterName, String argumentFieldName, Class type)
      PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
      void addNamedInOutputArgument​(String procedureParameterName, String inArgumentFieldName, String outArgumentFieldName, int type)
      PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
      void addNamedInOutputArgument​(String procedureParameterName, String inArgumentFieldName, String outArgumentFieldName, int type, String typeName)
      PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
      void addNamedInOutputArgument​(String procedureParameterName, String inArgumentFieldName, String outArgumentFieldName, int type, String typeName, Class classType)
      PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
      void addNamedInOutputArgument​(String procedureParameterName, String inArgumentFieldName, String outArgumentFieldName, int type, String typeName, Class javaType, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
      PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
      void addNamedInOutputArgument​(String procedureParameterName, String inArgumentFieldName, String outArgumentFieldName, Class type)
      PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
      void addNamedInOutputArgument​(String procedureParameterName, org.eclipse.persistence.internal.helper.DatabaseType databaseType)
      PUBLIC: Add a named IN OUT argument to the stored procedure.
      void addNamedInOutputArgument​(String procedureParameterName, org.eclipse.persistence.internal.helper.DatabaseType databaseType, int length)
      PUBLIC: Add a named IN OUT argument to the stored procedure.
      void addNamedInOutputArgument​(String procedureParameterName, org.eclipse.persistence.internal.helper.DatabaseType databaseType, int precision, int scale)
      PUBLIC: Add a named IN OUT argument to the stored procedure.
      void addNamedInOutputArgumentValue​(String procedureParameterName, Object inArgumentValue, String outArgumentFieldName, Class type)
      PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out.
      void addNamedOutputArgument​(String procedureParameterAndArgumentFieldName)
      PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedOutputArgument​(String procedureParameterName, String argumentFieldName)
      PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedOutputArgument​(String procedureParameterName, String argumentFieldName, int type)
      PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedOutputArgument​(String procedureParameterName, String argumentFieldName, int type, String typeName)
      PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedOutputArgument​(String procedureParameterName, String argumentFieldName, int jdbcType, String typeName, Class javaType)
      PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedOutputArgument​(String procedureParameterName, String argumentFieldName, int jdbcType, String typeName, Class javaType, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
      PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedOutputArgument​(String procedureParameterName, String argumentFieldName, Class type)
      PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it.
      void addNamedOutputArgument​(String procedureParameterName, org.eclipse.persistence.internal.helper.DatabaseType databaseType)
      PUBLIC: Add a named OUT argument to the stored procedure.
      void addNamedOutputArgument​(String procedureParameterName, org.eclipse.persistence.internal.helper.DatabaseType databaseType, int length)
      PUBLIC: Add a named OUT argument to the stored procedure.
      void addNamedOutputArgument​(String procedureParameterName, org.eclipse.persistence.internal.helper.DatabaseType databaseType, int precision, int scale)
      PUBLIC: Add a named OUT argument to the stored procedure.
      void addUnamedArgument​(String argumentFieldName)
      PUBLIC: Define the field/argument name to be substitute for the index argument.
      void addUnamedArgument​(String argumentFieldName, int type)
      PUBLIC: Define the argument to the stored procedure for the index argument.
      void addUnamedArgument​(String argumentFieldName, int type, String typeName)
      PUBLIC: Define the argument to the stored procedure for the index argument.
      void addUnamedArgument​(String argumentFieldName, int type, String typeName, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
      PUBLIC: Define the argument to the stored procedure for the index argument.
      void addUnamedArgument​(String argumentFieldName, Class type)
      PUBLIC: Define the argument to the stored procedure for the index argument.
      void addUnamedArgumentValue​(Object argumentValue)
      PUBLIC: Define the argument to the stored procedure for the index argument.
      void addUnamedInOutputArgument​(String argumentFieldName)
      PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
      void addUnamedInOutputArgument​(String argumentFieldName, Class type)
      PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
      void addUnamedInOutputArgument​(String inArgumentFieldName, String outArgumentFieldName, int type)
      PUBLIC: Define the argument to the stored procedure for the index argument.
      void addUnamedInOutputArgument​(String inArgumentFieldName, String outArgumentFieldName, int type, String typeName)
      PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
      void addUnamedInOutputArgument​(String inArgumentFieldName, String outArgumentFieldName, int type, String typeName, Class collection)
      PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
      void addUnamedInOutputArgument​(String inArgumentFieldName, String outArgumentFieldName, int type, String typeName, Class collection, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
      PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
      void addUnamedInOutputArgument​(String inArgumentFieldName, String outArgumentFieldName, Class type)
      PUBLIC: Define the argument to the stored procedure for the index argument.
      void addUnamedInOutputArgumentValue​(Object inArgumentValue, String outArgumentFieldName, Class type)
      PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out.
      void addUnamedOutputArgument​(String argumentFieldName)
      PUBLIC: Define the field/argument name to be substitute for the index output argument.
      void addUnamedOutputArgument​(String argumentFieldName, int type)
      PUBLIC: Define the field/argument name to be substitute for the index output argument.
      void addUnamedOutputArgument​(String argumentFieldName, int type, String typeName)
      PUBLIC: Define the field/argument name to be substitute for the index output argument.
      void addUnamedOutputArgument​(String argumentFieldName, int jdbcType, String typeName, Class javaType)
      PUBLIC: Define the field/argument name to be substitute for the index output argument.
      void addUnamedOutputArgument​(String argumentFieldName, int jdbcType, String typeName, Class javaType, org.eclipse.persistence.internal.helper.DatabaseField nestedType)
      PUBLIC: Define the field/argument name to be substitute for the index output argument.
      void addUnamedOutputArgument​(String argumentFieldName, Class type)
      PUBLIC: Define the field/argument name to be substitute for the index output argument.
      org.eclipse.persistence.internal.sessions.AbstractRecord buildOutputRow​(CallableStatement statement, org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor accessor, org.eclipse.persistence.internal.sessions.AbstractSession session)
      Translate the SQL procedure output row, into the row expected by the PLSQL procedure.
      List<PLSQLargument> getArguments()
      Return the PLSQL arguments.
      String getLogString​(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)
      INTERNAL: Build the log string for the call.
      String getPl2SQLName​(org.eclipse.persistence.internal.helper.ComplexDatabaseType type)
      Return the conversion function name, generate the function if missing.
      String getSQL2PlName​(org.eclipse.persistence.internal.helper.ComplexDatabaseType type)
      Return the conversion function name, generate the function if missing.
      boolean isStoredPLSQLProcedureCall()  
      void setArguments​(List<PLSQLargument> arguments)
      Set the PLSQL arguments.
      void translate​(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, org.eclipse.persistence.internal.sessions.AbstractRecord modifyRow, org.eclipse.persistence.internal.sessions.AbstractSession session)
      Translate the PLSQL procedure translation row, into the row expected by the SQL procedure.
      void useNamedCursorOutputAsResultSet​(String argumentName)
      PUBLIC: Used for Oracle result sets through procedures.
      void useNamedCursorOutputAsResultSet​(String argumentName, org.eclipse.persistence.internal.helper.DatabaseType databaseType)
      PUBLIC: Add a named OUT cursor argument to the stored procedure.
      void useUnnamedCursorOutputAsResultSet()
      PUBLIC: Used for Oracle result sets through procedures.

      • Methods inherited from class org.eclipse.persistence.internal.databaseaccess.DatabaseCall

        addContext, appendIn, appendInOut, appendInOut, appendLogParameters, appendOut, appendOutCursor, appendParameter, bindParameter, buildNewQueryMechanism, buildQueryMechanism, getCallString, getContexts, getCursorOutIndex, getExecuteReturnValue, getFields, getFieldsArray, getFirstResult, getMaxRows, getOutputCursors, getOutputRowFields, getQueryString, getQueryTimeout, getResult, getResultSetConcurrency, getResultSetFetchSize, getResultSetType, getReturnsResultSet, getSQLString, getStatement, hasAllocatedConnection, hasMultipleResultSets, hasOptimisticLock, hasOutputCursors, isBatchExecutionSupported, isCursorOutputProcedure, isCursorReturned, isFieldMatchingRequired, isFinished, isLOBLocatorNeeded, isMultipleCursorOutputProcedure, isNonCursorOutputProcedure, isResultSetScrollable, isUsesBindingSet, matchFieldOrder, prepare, prepareStatement, returnMultipleResultSetCollections, setBatchExecutionSupported, setContexts, setExecuteReturnValue, setFields, setFirstResult, setHasAllocatedConnection, setHasOptimisticLock, setIgnoreFirstRowSetting, setIgnoreMaxResultsSetting, setIsCursorOutputProcedure, setIsFieldMatchingRequired, setIsMultipleCursorOutputProcedure, setIsResultSetScrollable, setMaxRows, setQueryString, setQueryTimeout, setQueryTimeoutUnit, setResult, setResultSetConcurrency, setResultSetFetchSize, setResultSetType, setReturnMultipleResultSetCollections, setShouldCacheStatement, setStatement, setUsesBinding, shouldBuildOutputRow, shouldCacheStatement, shouldCacheStatement, shouldIgnoreFirstRowSetting, shouldIgnoreMaxResultsSetting, translateQueryStringForParameterizedIN, usesBinding, usesBinding

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

        appendIn, appendInOut, appendLiteral, appendModify, appendOut, appendTranslation, areManyRowsReturned, clone, getParameters, getParameterTypes, getQuery, getReturnType, hasParameters, isEISInteraction, isExecuteUpdate, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isReturnSet, isSQLCall, isStoredFunctionCall, isStoredPLSQLFunctionCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, setIsNativeConnectionRequired, setIsPrepared, setParameters, setParameterTypes, setQuery, setReturnType, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString

    • Constructor Detail

      • PLSQLStoredProcedureCall

        public PLSQLStoredProcedureCall()

    • Method Detail

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             org.eclipse.persistence.internal.helper.DatabaseType databaseType)
        PUBLIC: Add a named IN argument to the stored procedure. The databaseType parameter classifies the parameter (JDBCType vs. OraclePLSQLType, simple vs. complex)

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             org.eclipse.persistence.internal.helper.DatabaseType databaseType,
                             int length)
        PUBLIC: Add a named IN argument to the stored procedure. The databaseType parameter classifies the parameter (JDBCType vs. OraclePLSQLType, simple vs. complex). The extra length parameter indicates that this parameter, when used in an Anonymous PL/SQL block, requires a length.

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             org.eclipse.persistence.internal.helper.DatabaseType databaseType,
                             int precision,
                             int scale)
        PUBLIC: Add a named IN argument to the stored procedure. The databaseType parameter classifies the parameter (JDBCType vs. OraclePLSQLType, simple vs. complex). The extra scale and precision parameters indicates that this parameter, when used in an Anonymous PL/SQL block, requires scale and precision specification

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             String argumentFieldName,
                             int type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the input argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used to pass to the user. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this is dependent on the type required by the procedure.
        Overrides:
        addNamedArgument in class StoredProcedureCall

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             String argumentFieldName,
                             int type,
                             String typeName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used to pass to the procedure. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this is dependent on the type required by the procedure. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
        Overrides:
        addNamedArgument in class StoredProcedureCall

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     org.eclipse.persistence.internal.helper.DatabaseType databaseType)
        PUBLIC: Add a named IN OUT argument to the stored procedure. The databaseType parameter classifies the parameter (JDBCType vs. OraclePLSQLType, simple vs. complex)

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     org.eclipse.persistence.internal.helper.DatabaseType databaseType,
                                     int length)
        PUBLIC: Add a named IN OUT argument to the stored procedure. The databaseType parameter classifies the parameter (JDBCType vs. OraclePLSQLType, simple vs. complex). The extra length parameter indicates that this parameter, when used in an Anonymous PL/SQL block, requires a length.

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     org.eclipse.persistence.internal.helper.DatabaseType databaseType,
                                     int precision,
                                     int scale)
        PUBLIC: Add a named IN OUT argument to the stored procedure. The databaseType parameter classifies the parameter (JDBCType vs. OraclePLSQLType, simple vs. complex). The extra scale and precision parameters indicates that this parameter, when used in an Anonymous PL/SQL block, requires scale and precision specification

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     String inArgumentFieldName,
                                     String outArgumentFieldName,
                                     int type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out. The procedureParameterName is the name of the procedure argument expected. The inArgumentFieldName is the field or argument name to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this dependent on the type returned from the procedure.
        Overrides:
        addNamedInOutputArgument in class StoredProcedureCall

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     String inArgumentFieldName,
                                     String outArgumentFieldName,
                                     int type,
                                     String typeName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out. The procedureParameterName is the name of the procedure argument expected. The inArgumentFieldName is the field or argument name to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
        Overrides:
        addNamedInOutputArgument in class StoredProcedureCall

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     String inArgumentFieldName,
                                     String outArgumentFieldName,
                                     int type,
                                     String typeName,
                                     Class classType)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out. The procedureParameterName is the name of the procedure argument expected. The inArgumentFieldName is the field or argument name to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for STRUCT and ARRAY types. The classType is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
        Overrides:
        addNamedInOutputArgument in class StoredProcedureCall

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     String inArgumentFieldName,
                                     String outArgumentFieldName,
                                     int type,
                                     String typeName,
                                     Class javaType,
                                     org.eclipse.persistence.internal.helper.DatabaseField nestedType)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out. The procedureParameterName is the name of the procedure argument expected. The inArgumentFieldName is the field or argument name to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY types. The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible. The nestedType is a DatabaseField with type information set to match the VARRAYs object types
        Overrides:
        addNamedInOutputArgument in class StoredProcedureCall

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterName,
                                   org.eclipse.persistence.internal.helper.DatabaseType databaseType)
        PUBLIC: Add a named OUT argument to the stored procedure. The databaseType parameter classifies the parameter (JDBCType vs. OraclePLSQLType, simple vs. complex)

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterName,
                                   org.eclipse.persistence.internal.helper.DatabaseType databaseType,
                                   int length)
        PUBLIC: Add a named OUT argument to the stored procedure. The databaseType parameter classifies the parameter (JDBCType vs. OraclePLSQLType, simple vs. complex). The extra length parameter indicates that this parameter, when used in an Anonymous PL/SQL block, requires a length.

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterName,
                                   org.eclipse.persistence.internal.helper.DatabaseType databaseType,
                                   int precision,
                                   int scale)
        PUBLIC: Add a named OUT argument to the stored procedure. The databaseType parameter classifies the parameter (JDBCType vs. OraclePLSQLType, simple vs. complex). The extra scale and precision parameters indicates that this parameter, when used in an Anonymous PL/SQL block, requires scale and precision specification

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterName,
                                   String argumentFieldName,
                                   int jdbcType,
                                   String typeName,
                                   Class javaType)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used is the result of the output row. The jdbcType is the JDBC type code, this dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY and STRUCT types. The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible.
        Overrides:
        addNamedOutputArgument in class StoredProcedureCall

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterName,
                                   String argumentFieldName,
                                   int jdbcType,
                                   String typeName,
                                   Class javaType,
                                   org.eclipse.persistence.internal.helper.DatabaseField nestedType)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used is the result of the output row. The jdbcType is the JDBC type code, this dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY and STRUCT types. The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible. The nestedType is a DatabaseField with type information set to match the VARRAYs object types
        Overrides:
        addNamedOutputArgument in class StoredProcedureCall

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterName,
                                   String argumentFieldName,
                                   int type,
                                   String typeName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used to pass to the procedure. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this is dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
        Overrides:
        addNamedOutputArgument in class StoredProcedureCall

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterName,
                                   String argumentFieldName,
                                   int type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used to pass to the procedure. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this is dependent on the type returned from the procedure.
        Overrides:
        addNamedOutputArgument in class StoredProcedureCall

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterAndArgumentFieldName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterAndArgumentFieldName is the name of the procedure argument expected, and is the field or argument name to be used to pass to the procedure. These names are assumed to be the same, if not this method can be called with two arguments.
        Overrides:
        addNamedArgument in class StoredProcedureCall

      • addNamedArgumentValue

        public void addNamedArgumentValue​(String procedureParameterName,
                                  Object argumentValue)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the argument to the stored procedure and the value to be substitute for it. The procedureParameterName is the name of the procedure argument expected. The argumentValue is the value of the argument to be used to pass to the procedure.
        Overrides:
        addNamedArgumentValue in class StoredProcedureCall

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             String argumentFieldName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used to pass to the procedure. If these names are the same (as they normally are) this method can be called with a single argument.
        Overrides:
        addNamedArgument in class StoredProcedureCall

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterAndArgumentFieldName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out. The procedureParameterAndArgumentFieldName is the name of the procedure argument expected, the field or argument name to be used to pass to the procedure and, the field or argument name to be used is the result of the output row.
        Overrides:
        addNamedInOutputArgument in class StoredProcedureCall

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     String argumentFieldName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used to pass to the procedure and is the result of the output row.
        Overrides:
        addNamedInOutputArgument in class StoredProcedureCall

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     String argumentFieldName,
                                     Class type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used to pass to the procedure and is the result of the output row. The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
        Overrides:
        addNamedInOutputArgument in class StoredProcedureCall

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     String inArgumentFieldName,
                                     String outArgumentFieldName,
                                     Class type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out. The procedureParameterName is the name of the procedure argument expected. The inArgumentFieldName is the field or argument name to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type the Java class desired back from the procedure, if a struct is returned and the class has an ObjectRelationalDataTypeDescriptor defined .
        Overrides:
        addNamedInOutputArgument in class StoredProcedureCall

      • addNamedInOutputArgumentValue

        public void addNamedInOutputArgumentValue​(String procedureParameterName,
                                          Object inArgumentValue,
                                          String outArgumentFieldName,
                                          Class type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure and the field/argument name to be substitute for it on the way in and out. The procedureParameterName is the name of the procedure argument expected. The inArgumentValue is the value of the argument to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
        Overrides:
        addNamedInOutputArgumentValue in class StoredProcedureCall

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterAndArgumentFieldName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterAndArgumentFieldName is the name of the procedure argument expected, and is the field or argument name to be used to pass to the procedure. These names are assumed to be the same, if not this method can be called with two arguments.
        Overrides:
        addNamedOutputArgument in class StoredProcedureCall

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterName,
                                   String argumentFieldName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used to pass to the procedure. If these names are the same (as they normally are) this method can be called with a single argument.
        Overrides:
        addNamedOutputArgument in class StoredProcedureCall

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterName,
                                   String argumentFieldName,
                                   Class type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the output argument to the stored procedure and the field/argument name to be substitute for it. The procedureParameterName is the name of the procedure argument expected. The argumentFieldName is the field or argument name to be used to pass to the procedure. If these names are the same (as they normally are) this method can be called with a single argument. The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
        Overrides:
        addNamedOutputArgument in class StoredProcedureCall

      • addUnamedArgument

        public void addUnamedArgument​(String argumentFieldName,
                              Class type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the argument to the stored procedure for the index argument. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The argumentFieldName is the field or argument name to be used to pass to the user. The type is the type of Java class for the field, and is dependent on the type required by the procedure. This is used to set the type in case null is passed in.
        Overrides:
        addUnamedArgument in class StoredProcedureCall

      • addUnamedArgument

        public void addUnamedArgument​(String argumentFieldName,
                              int type,
                              String typeName,
                              org.eclipse.persistence.internal.helper.DatabaseField nestedType)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the argument to the stored procedure for the index argument. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The argumentFieldName is the field or argument name to be used to pass to the procedure. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this is dependent on the type required by the procedure. The typeName is the JDBC type name, as required for STRUCT and ARRAY types. The nestedType is a DatabaseField with type information set to match the VARRAYs object types
        Overrides:
        addUnamedArgument in class StoredProcedureCall

      • addUnamedArgument

        public void addUnamedArgument​(String argumentFieldName,
                              int type,
                              String typeName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the argument to the stored procedure for the index argument. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The argumentFieldName is the field or argument name to be used to pass to the procedure. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this is dependent on the type required by the procedure. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
        Overrides:
        addUnamedArgument in class StoredProcedureCall

      • addUnamedArgument

        public void addUnamedArgument​(String argumentFieldName,
                              int type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the argument to the stored procedure for the index argument. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The argumentFieldName is the field or argument name to be used to pass to the user. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this is dependent on the type required by the procedure.
        Overrides:
        addUnamedArgument in class StoredProcedureCall

      • addUnamedArgument

        public void addUnamedArgument​(String argumentFieldName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the field/argument name to be substitute for the index argument. This method is used if the procedure is not named and the order is explicit, names must be added in the correct order. The argumentFieldName is the field or argument name to be used to pass to the procedure.
        Overrides:
        addUnamedArgument in class StoredProcedureCall

      • addUnamedArgumentValue

        public void addUnamedArgumentValue​(Object argumentValue)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the argument to the stored procedure for the index argument. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The argumentValue is the value of the argument to be used to pass to the procedure.
        Overrides:
        addUnamedArgumentValue in class StoredProcedureCall

      • addUnamedInOutputArgument

        public void addUnamedInOutputArgument​(String argumentFieldName,
                                      Class type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The argumentFieldName is the field name of the argument to be used to pass to the procedure and to be used is the result of the output row. The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
        Overrides:
        addUnamedInOutputArgument in class StoredProcedureCall

      • addUnamedInOutputArgument

        public void addUnamedInOutputArgument​(String inArgumentFieldName,
                                      String outArgumentFieldName,
                                      Class type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the argument to the stored procedure for the index argument. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The inArgumentFieldName is the field name of the argument to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
        Overrides:
        addUnamedInOutputArgument in class StoredProcedureCall

      • addUnamedInOutputArgument

        public void addUnamedInOutputArgument​(String inArgumentFieldName,
                                      String outArgumentFieldName,
                                      int type,
                                      String typeName,
                                      Class collection,
                                      org.eclipse.persistence.internal.helper.DatabaseField nestedType)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The argumentFieldName is the field or argument name to be used is the result of the output row. The jdbcType is the JDBC type code, this dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY and STRUCT types. The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible. The nestedType is a DatabaseField with type information set to match the VARRAYs object types
        Overrides:
        addUnamedInOutputArgument in class StoredProcedureCall

      • addUnamedInOutputArgument

        public void addUnamedInOutputArgument​(String inArgumentFieldName,
                                      String outArgumentFieldName,
                                      int type,
                                      String typeName,
                                      Class collection)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The inArgumentFieldName is the field or argument name to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY types. The collectionClass is the java class to return instead of the ARRAY type.
        Overrides:
        addUnamedInOutputArgument in class StoredProcedureCall

      • addUnamedInOutputArgument

        public void addUnamedInOutputArgument​(String inArgumentFieldName,
                                      String outArgumentFieldName,
                                      int type,
                                      String typeName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The inArgumentFieldName is the field name of the argument to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this is dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
        Overrides:
        addUnamedInOutputArgument in class StoredProcedureCall

      • addUnamedInOutputArgument

        public void addUnamedInOutputArgument​(String inArgumentFieldName,
                                      String outArgumentFieldName,
                                      int type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the argument to the stored procedure for the index argument. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The inArgumentFieldName is the field name of the argument to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type is the JDBC type code, this is dependent on the type returned from the procedure.
        Overrides:
        addUnamedInOutputArgument in class StoredProcedureCall

      • addUnamedInOutputArgument

        public void addUnamedInOutputArgument​(String argumentFieldName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The argumentFieldName is the field name of the argument to be used to pass to the procedure and to be used is the result of the output row.
        Overrides:
        addUnamedInOutputArgument in class StoredProcedureCall

      • addUnamedInOutputArgumentValue

        public void addUnamedInOutputArgumentValue​(Object inArgumentValue,
                                           String outArgumentFieldName,
                                           Class type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the inoutput argument to the stored procedure for the index argument and the field/argument name to be substitute for it on the way in and out. This method is used if the procedure is not named and the order is explicit, arguments must be added in the correct order. The inArgumentValue is the value of the argument to be used to pass to the procedure. The outArgumentFieldName is the field or argument name to be used is the result of the output row. If these names are the same (as they normally are) this method can be called with a single argument. The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
        Overrides:
        addUnamedInOutputArgumentValue in class StoredProcedureCall

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName,
                                    Class type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the field/argument name to be substitute for the index output argument. This method is used if the procedure is not named and the order is explicit, names must be added in the correct order. The argumentFieldName is the field or argument name to be used to pass to the procedure. The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
        Overrides:
        addUnamedOutputArgument in class StoredProcedureCall

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName,
                                    int jdbcType,
                                    String typeName,
                                    Class javaType,
                                    org.eclipse.persistence.internal.helper.DatabaseField nestedType)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the field/argument name to be substitute for the index output argument. This method is used if the procedure is not named and the order is explicit, names must be added in the correct order. The argumentFieldName is the field or argument name to be used is the result of the output row. The jdbcType is the JDBC type code, this dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY and STRUCT types. The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible. The nestedType is a DatabaseField with type information set to match the VARRAYs object types
        Overrides:
        addUnamedOutputArgument in class StoredProcedureCall

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName,
                                    int jdbcType,
                                    String typeName,
                                    Class javaType)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the field/argument name to be substitute for the index output argument. This method is used if the procedure is not named and the order is explicit, names must be added in the correct order. The argumentFieldName is the field or argument name to be used is the result of the output row. The jdbcType is the JDBC type code, this dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY and STRUCT types. The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible.
        Overrides:
        addUnamedOutputArgument in class StoredProcedureCall

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName,
                                    int type,
                                    String typeName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the field/argument name to be substitute for the index output argument. This method is used if the procedure is not named and the order is explicit, names must be added in the correct order. The argumentFieldName is the field or argument name to be used to pass to the procedure. The type is the JDBC type code, this is dependent on the type returned from the procedure. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.
        Overrides:
        addUnamedOutputArgument in class StoredProcedureCall

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName,
                                    int type)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the field/argument name to be substitute for the index output argument. This method is used if the procedure is not named and the order is explicit, names must be added in the correct order. The argumentFieldName is the field or argument name to be used to pass to the procedure. The type is the JDBC type code, this is dependent on the type returned from the procedure.
        Overrides:
        addUnamedOutputArgument in class StoredProcedureCall

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName)
        Description copied from class: StoredProcedureCall
        PUBLIC: Define the field/argument name to be substitute for the index output argument. This method is used if the procedure is not named and the order is explicit, names must be added in the correct order. The argumentFieldName is the field or argument name to be used to pass to the procedure. The type is the type of Java class desired back from the procedure, this is dependent on the type returned from the procedure.
        Overrides:
        addUnamedOutputArgument in class StoredProcedureCall

      • useNamedCursorOutputAsResultSet

        public void useNamedCursorOutputAsResultSet​(String argumentName,
                                            org.eclipse.persistence.internal.helper.DatabaseType databaseType)
        PUBLIC: Add a named OUT cursor argument to the stored procedure. The databaseType parameter classifies the parameter (JDBCType vs. OraclePLSQLType, simple vs. complex).

      • translate

        public void translate​(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow,
                      org.eclipse.persistence.internal.sessions.AbstractRecord modifyRow,
                      org.eclipse.persistence.internal.sessions.AbstractSession session)
        Translate the PLSQL procedure translation row, into the row expected by the SQL procedure. This handles expanding and re-ordering parameters.
        Overrides:
        translate in class org.eclipse.persistence.internal.databaseaccess.DatabaseCall

      • buildOutputRow

        public org.eclipse.persistence.internal.sessions.AbstractRecord buildOutputRow​(CallableStatement statement,
                                                                               org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor accessor,
                                                                               org.eclipse.persistence.internal.sessions.AbstractSession session)
                                                                        throws SQLException
        Translate the SQL procedure output row, into the row expected by the PLSQL procedure. This handles re-ordering parameters.
        Overrides:
        buildOutputRow in class org.eclipse.persistence.internal.databaseaccess.DatabaseCall
        Throws:
        SQLException

      • getLogString

        public String getLogString​(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)
        INTERNAL: Build the log string for the call.
        Specified by:
        getLogString in interface Call
        Overrides:
        getLogString in class org.eclipse.persistence.internal.databaseaccess.DatabaseCall

      • getSQL2PlName

        public String getSQL2PlName​(org.eclipse.persistence.internal.helper.ComplexDatabaseType type)
        Return the conversion function name, generate the function if missing.

      • isStoredPLSQLProcedureCall

        public boolean isStoredPLSQLProcedureCall()
        Overrides:
        isStoredPLSQLProcedureCall in class org.eclipse.persistence.internal.databaseaccess.DatasourceCall

      • getPl2SQLName

        public String getPl2SQLName​(org.eclipse.persistence.internal.helper.ComplexDatabaseType type)
        Return the conversion function name, generate the function if missing.

      • getArguments

        public List<PLSQLargument> getArguments()
        Return the PLSQL arguments.

      • setArguments

        public void setArguments​(List<PLSQLargument> arguments)
        Set the PLSQL arguments.