Package org.eclipse.persistence.queries

Class StoredProcedureCall

    • Field Detail

      • procedureName

        protected String procedureName

      • procedureArgumentNames

        protected List<String> procedureArgumentNames

    • Constructor Detail

      • StoredProcedureCall

        public StoredProcedureCall()

    • Method Detail

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterAndArgumentFieldName)
        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.

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             String argumentFieldName)
        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.

      • addNamedArgumentValue

        public void addNamedArgumentValue​(String procedureParameterName,
                                  Object argumentValue)
        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.

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             String argumentFieldName,
                             Class type)
        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. 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.

      • addNamedArgument

        public 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. 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.

      • addNamedArgument

        public 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. 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.

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             String argumentFieldName,
                             int type,
                             String typeName,
                             Class javaType)
        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. The javaType is the mapped Class that has an ObjectRelationalDataTypeDescriptor for the ARRAY or STRUCT type typeName

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             String argumentFieldName,
                             int type,
                             String typeName,
                             Class javaType,
                             DatabaseField nestedType)
        PUBLIC: Define the inout argument to the stored procedure and the field/argument name to be substituted 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. 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. The javaType is the mapped Class that has an ObjectRelationalDataTypeDescriptor for the ARRAY or STRUCT type typeName The nestedType is a DatabaseField with type information set to match the VARRAYs object types

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             String argumentFieldName,
                             int type,
                             String typeName,
                             String javaTypeName)
        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. The javaType is the name of the mapped Class that has an ObjectRelationalDataTypeDescriptor for the ARRAY or STRUCT type typeName

      • addNamedArgument

        public void addNamedArgument​(String procedureParameterName,
                             String argumentFieldName,
                             int type,
                             String typeName,
                             DatabaseField nestedType)
        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, as required for STRUCT and ARRAY types. The nestedType is a DatabaseField with type information set to match the VARRAYs object types

      • addNamedInOutputArgument

        public 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. 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.

      • addNamedInOutputArgument

        public 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. 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.

      • addNamedInOutputArgument

        public 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. 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.

      • addNamedInOutputArgument

        public 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. 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 .

      • addNamedInOutputArgument

        public 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. 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.

      • addNamedInOutputArgument

        public 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. 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.

      • addNamedInOutputArgument

        public 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. 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.

      • addNamedInOutputArgument

        public void addNamedInOutputArgument​(String procedureParameterName,
                                     String inArgumentFieldName,
                                     String outArgumentFieldName,
                                     int type,
                                     String typeName,
                                     Class javaType,
                                     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. 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

      • addNamedInOutputArgumentValue

        public 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. 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.

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterAndArgumentFieldName)
        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.

      • addNamedOutputArgument

        public 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. 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.

      • addNamedOutputArgument

        public 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. 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.

      • addNamedOutputArgument

        public 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. 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.

      • addNamedOutputArgument

        public 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. 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.

      • addNamedOutputArgument

        public 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. 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.

      • addNamedOutputArgument

        public void addNamedOutputArgument​(String procedureParameterName,
                                   String argumentFieldName,
                                   int jdbcType,
                                   String typeName,
                                   Class javaType,
                                   DatabaseField nestedType)
        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

      • addUnamedArgument

        public void addUnamedArgument​(String argumentFieldName)
        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.

      • addUnamedArgumentValue

        public void addUnamedArgumentValue​(Object argumentValue)
        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.

      • addUnamedArgument

        public void addUnamedArgument​(String argumentFieldName,
                              Class type)
        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.

      • addUnamedArgument

        public void addUnamedArgument​(String argumentFieldName,
                              int type)
        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.

      • addUnamedArgument

        public void addUnamedArgument​(String argumentFieldName,
                              int type,
                              String typeName)
        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.

      • addUnamedArgument

        public void addUnamedArgument​(String argumentFieldName,
                              int type,
                              String typeName,
                              DatabaseField nestedType)
        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

      • addUnamedInOutputArgument

        public void addUnamedInOutputArgument​(String inArgumentFieldName,
                                      String outArgumentFieldName,
                                      Class type)
        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.

      • addUnamedInOutputArgument

        public void addUnamedInOutputArgument​(String inArgumentFieldName,
                                      String outArgumentFieldName,
                                      int type)
        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.

      • addUnamedInOutputArgument

        public 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. 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.

      • addUnamedInOutputArgument

        public 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. 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.

      • addUnamedInOutputArgument

        public 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. 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.

      • addUnamedInOutputArgument

        public 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. 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.

      • addUnamedInOutputArgument

        public void addUnamedInOutputArgument​(String inArgumentFieldName,
                                      String outArgumentFieldName,
                                      int type,
                                      String typeName,
                                      Class collection,
                                      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. 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

      • addUnamedInOutputArgumentValue

        public 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. 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.

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName)
        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.

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName,
                                    Class type)
        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.

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName,
                                    int type)
        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.

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName,
                                    int type,
                                    String typeName)
        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.

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName,
                                    int jdbcType,
                                    String typeName,
                                    Class javaType)
        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.

      • addUnamedOutputArgument

        public void addUnamedOutputArgument​(String argumentFieldName,
                                    int jdbcType,
                                    String typeName,
                                    Class javaType,
                                    DatabaseField nestedType)
        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

      • getCallHeader

        public String getCallHeader​(DatabasePlatform platform)
        INTERNAL: Return call header for the call string.

      • getFirstParameterIndexForCallString

        public int getFirstParameterIndexForCallString()
        INTERNAL: Return the first index of parameter to be placed inside brackets in the call string

      • getProcedureArgumentNames

        public List<String> getProcedureArgumentNames()
        INTERNAL: The if the names are provide the order is not required to match the call def. This is lazy initialized to conserve space on calls that have no parameters. If the argument name is null, then it is a positional parameter.

      • getProcedureName

        public String getProcedureName()
        PUBLIC: Return the name of the store procedure on the database.

      • isCallableStatementRequired

        protected boolean isCallableStatementRequired()
        Callable statements are used for StoredProcedures that have argument names (named parameters)
        Overrides:
        isCallableStatementRequired in class DatabaseCall

      • setProcedureArgumentNames

        public void setProcedureArgumentNames​(List<String> procedureArgumentNames)
        INTERNAL: The if the names are provide the order is not required to match the call def. This is lazy initialized to conserve space on calls that have no parameters.

      • setProcedureName

        public void setProcedureName​(String procedureName)
        PUBLIC: (REQUIRED) Set the name of the store procedure on the database.

      • addNamedCursorOutputArgument

        public void addNamedCursorOutputArgument​(String argumentName)
        ADVANCED: Add the cursor output parameter to the procedure. This is used for procedures that have multiple cursor output parameters. If the procedure has a single cursor output parameter, then useNamedCursorOutputAsResultSet() should be used.

      • addUnnamedCursorOutputArgument

        public void addUnnamedCursorOutputArgument​(String outputRowFieldName)
        ADVANCED: Add the cursor output parameter to the procedure. This is used for procedures that have multiple cursor output parameters. If the procedure has a single cursor output parameter, then useNamedCursorOutputAsResultSet() should be used.

      • useCursorOutputResultSet

        protected void useCursorOutputResultSet​(String argumentName,
                                        String outputFieldName)
        INTERNAL: Add the unnamed output cursor to return the result.

      • useNamedCursorOutputAsResultSet

        public void useNamedCursorOutputAsResultSet​(String argumentName)
        PUBLIC: Used for Oracle result sets through procedures. This can only be used if the arguments are not named but ordered.

      • useUnnamedCursorOutputAsResultSet

        public void useUnnamedCursorOutputAsResultSet()
        PUBLIC: Used for Oracle result sets through procedures. This can only be used if the arguments are not named but ordered.
        Overrides:
        useUnnamedCursorOutputAsResultSet in class DatabaseCall

      • useUnnamedCursorOutputAsResultSet

        public void useUnnamedCursorOutputAsResultSet​(int position)
        PUBLIC: Used for Oracle result sets through procedures. This can only be used if the arguments are not named but ordered.

      • setHasMultipleResultSets

        public void setHasMultipleResultSets​(boolean hasMultipleResultSets)
        PUBLIC: Set if the call returns multiple result sets. Some databases support having stored procedures that return multiple result set. This can be used by data queries, if an object query is used, all of the result sets must return the required data to build the resulting class.
        Overrides:
        setHasMultipleResultSets in class DatabaseCall

      • setReturnsResultSet

        public void setReturnsResultSet​(boolean returnsResultSet)
        PUBLIC: Some database support stored procedures returning result sets. This default to true in the call has no output parameters, otherwise false. If the call returns a result set, and has output parameters, this can be set to true. If the call is used in a modify query, it is assumed to not have a result set, result sets can only be used by read queries. For Oracle a cursored output parameter can be used instead of a result set.
        Overrides:
        setReturnsResultSet in class DatabaseCall

      • addOptionalArgument

        public void addOptionalArgument​(String argument)
        PUBLIC: Add the optional argument. This will be ignored if null and defaulted by the database.

      • hasOptionalArguments

        public boolean hasOptionalArguments()
        INTERNAL: Return if there are any optional arguments.

      • getOptionalArguments

        public List<DatabaseField> getOptionalArguments()
        INTERNAL: Return the list of optional arguments. These will be ignored if null and defaulted by the database.

      • setOptionalArguments

        public void setOptionalArguments​(List<DatabaseField> optionalArguments)
        INTERNAL: Set the list of optional arguments. These will be ignored if null and defaulted by the database.

      • getOutputParameterValue

        public Object getOutputParameterValue​(CallableStatement statement,
                                      int index,
                                      AbstractSession session)
                               throws SQLException
        Description copied from class: DatabaseCall
        INTERNAL: Get the return object from the statement. Use the parameter index to determine what return object to get.
        Overrides:
        getOutputParameterValue in class DatabaseCall
        Parameters:
        statement - SQL/JDBC statement to call stored procedure/function
        index - 0-based index in the argument list
        session - Active database session (in connected state).
        Returns:
        Throws:
        SQLException

      • bindParameter

        public void bindParameter​(Writer writer,
                          Object parameter)
        Bind the parameter. Binding is determined by the call and second the platform.
        Overrides:
        bindParameter in class DatabaseCall