FndStatement (IFS Java Server Framework API documentation (for internal use only))

java.lang.Object
- ifs.fnd.sf.storage.FndStatement

All Implemented Interfaces:

FndSqlData, ifs.fnd.sf.admin.FndAbortableProcess, java.lang.AutoCloseable

Direct Known Subclasses:

FndStandardStatement
```
public abstract class FndStatement
extends java.lang.Object
implements ifs.fnd.sf.admin.FndAbortableProcess, FndSqlData, java.lang.AutoCloseable
```
Framework internal class: Database statement created on a specific database connection. Parameters (both in, in-out and out) must be defined in the order they appear in the statement string (or procedure call) before a call to prepare/prepareCall. Results are fetched from result using get-methods after executing the statement.
This is a framework internal class! Backward compatibility is not guaranteed.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.sql.Connection`	`c` Internal connection.
`protected boolean`	`callable` Flag indicating if the statement is a procedure call.
`protected static int`	`DEFAULT_BUFFER_SIZE` Default Buffer Size (65536)
`protected Logger`	`log` Database logger
`protected java.util.List<FndSqlValue>`	`parameters` List of parameters.
`protected FndResultSet`	`result` Internal result set.
`protected java.sql.PreparedStatement`	`stmt` Internal statement.
`protected java.util.Calendar`	`utcCalendar` Create a calendar object for TimeStamps to be in UTC Time

Constructor Summary

Constructors
Modifier Constructor and Description

protected FndStatement(FndConnection fndConnection)
Creates a new instance of FndStatement

Constructors
Modifier	Constructor and Description
`protected`	`FndStatement(FndConnection fndConnection)` Creates a new instance of FndStatement

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abort()` Attempt to abort an executing statement.
`protected void`	`bindArguments()` Bind arguments to statement and register out parameters (if any).
`protected abstract void`	`checkError(java.sql.SQLException e)` Check if the original error should be re-thrown as some other kind of error.
`void`	`checkResult()` Verify that a result exists.
`void`	`clearFetchedSize()` Clears the internal counter with approximate number of bytes fetched by query operation.
`void`	`clearParameters()` Clear previously defined parameters.
`void`	`clearParameters(int index)` Clear previously defined parameters beginning at the specified index.
`void`	`close()` Close internal JDBC statement.
`boolean`	`closeRefCursorStatement()` Check if the statement that returned a REF CURSOR should be closed after retrieving the cursor.
`protected void`	`debugNull(FndSqlValue val, int colNr)` Used to debug null valued bind parameter.
`void`	`defineInOutParameter(FndSqlValue value)` Define an inout parameter for a procedure call.
`void`	`defineInParameter(FndAttribute attr)` Bind an argument (attribute value).
`void`	`defineInParameter(FndSqlValue value)` Bind an argument.
`void`	`defineOutParameter(java.lang.String name, FndSqlType type)` Define an out parameter for a procedure call.
`void`	`defineParameter(FndSqlValue value)` Define a parameter.
`boolean`	`defineRefCursorVariable()` Check if REF CURSOR bind variable should be registered as OUT parameter.
`boolean`	`execute()` Execute any kind of statement.
`boolean`	`execute(boolean registerAsAbortableProcess)` Execute any kind of statement.
`void`	`executeQuery()` Execute SQL query and register this statement as an abortable process.
`void`	`executeQuery(boolean registerAsAbortableProcess)` Execute SQL query.
`int`	`executeUpdate()` Execute SQL update/insert/delete.
`protected java.lang.String`	`formatSize(int size)` Formats size into a String.
`java.math.BigDecimal`	`getBigDecimal(int colNr)` Get column (decimal) value from database (can only be used after executeQuery).
`byte[]`	`getBinary(int colNr)` Get column (binary) value from database (can only be used after executeQuery).
`boolean`	`getBinary(int colNr, FndOutputStreamManager outputMgr)` Get column (binary) value from database into a stream.
`protected java.sql.Blob`	`getBlob(int colNr)` Get Blob locator.
`boolean`	`getBoolean(int colNr)` Get column (boolean) value from database (can only be used after executeQuery).
`protected int`	`getBufferSize(java.sql.Blob blob)` Get the buffer size to use when reading Blob.
`protected int`	`getBufferSize(java.sql.Clob clob)` Get the buffer size to use when reading Clob.
`protected java.sql.Clob`	`getClob(int colNr)` Get Clob locator.
`java.sql.ResultSet`	`getCursor(int parameterIndex)` Deprecated. use getFndCursor() instead
`java.sql.Date`	`getDate(int colNr)` Get column (date) value from database (can only be used after executeQuery).
`double`	`getDouble(int colNr)` Get column (double) value from database (can only be used after executeQuery).
`long`	`getFetchedSize()` Gets approximate number of bytes fetched by query operation.
`protected FndConnection`	`getFndConnection()` Gets the instance of FndConnection that owns this statement.
`FndResultSet`	`getFndCursor(int parameterIndex)` Get Ref Cursor value from a procedure call.
`FndResultSet`	`getFndResult()` Get result set from executed statement.
`int`	`getInt(int colNr)` Get column (int) value from database (can only be used after executeQuery).
`long`	`getLong(int colNr)` Get column (long) value from database (can only be used after executeQuery).
`byte[]`	`getLongRaw(int colNr)` Get column (binary) value from database (can only be used after executeQuery).
`java.lang.String`	`getLongText(int colNr)` Get column (long text) value from database (can only be used after executeQuery).
`protected java.lang.String`	`getLongTextImpl(int colNr)`
`protected java.lang.String`	`getMessage(java.lang.Exception e)` Returns error message for given Exception removing white space from both ends of the string.
`protected java.math.BigDecimal`	`getOutBigDecimal(int parameterIndex)`
`protected boolean`	`getOutBoolean(int parameterIndex)` Get a out-parameter value
`protected java.sql.Date`	`getOutDate(int parameterIndex)`
`protected double`	`getOutDouble(int parameterIndex)`
`protected int`	`getOutInt(int parameterIndex)`
`protected long`	`getOutLong(int parameterIndex)`
`protected byte[]`	`getOutLongRaw(int parameterIndex)` Get a out-parameter value
`protected java.lang.String`	`getOutString(int parameterIndex)` Get an out-parameter value.
`protected java.sql.Time`	`getOutTime(int parameterIndex)`
`protected java.sql.Timestamp`	`getOutTimestamp(int parameterIndex)` Get timestamp value from an out parameter.
`FndRefCursor`	`getRefCursor()` Retrieves the REF CURSOR returned by this statement.
`java.sql.ResultSet`	`getResult()` Deprecated. use getFndResult() instead
`java.lang.String`	`getSqlText()`
`java.lang.String`	`getString(int colNr)` Get column (string) value from database (can only be used after executeQuery).
`java.lang.String`	`getText(int colNr)` Get column (text) value from database (can only be used after executeQuery).
`java.sql.Time`	`getTime(int colNr)` Get column (time) value from database (can only be used after executeQuery).
`java.sql.Timestamp`	`getTimestamp(int colNr)` Get timestamp value from a executed statement or procedure call.
`protected boolean`	`isShortClobParameter(int pos)` Checks if the parameter bound at the specified position is a short (less than 32K) CLOB.
`protected java.lang.String`	`nativeSql(FndAutoString sql)` Convert sql string to native sql (as translated by the driver).
`protected java.lang.String`	`nativeSql(java.lang.String sql)` Convert sql string to native sql (as translated by the driver).
`boolean`	`parameterWasNull()` Retrieves whether the last OUT parameter read had the value of SQL NULL.
`void`	`prepare(FndAutoString sql)` Prepare SQL statement.
`void`	`prepare(FndAutoString sql, boolean updateable)` Prepare SQL statement and control if resultset should be updateable or not.
`void`	`prepare(java.lang.String sql)` Prepare SQL statement.
`void`	`prepare(java.lang.String sql, boolean updateable)` Prepare SQL statement and control if resultset should be updateable or not.
`void`	`prepareCall(FndAutoString sql)` Prepare a procedure call.
`void`	`prepareCall(java.lang.String sql)` Prepare a procedure call.
`protected void`	`prepareStatement(FndAutoString sql, boolean updateable)` Prepare SQL statement.
`protected void`	`prepareStatement(java.lang.String sql, boolean updateable)` Prepare SQL statement.
`void`	`recreateLogger()` Recreates the logger stored in a protected instance variable.
`protected void`	`registerOutParameter(FndSqlValue param, int parameterIndex)` Register a out/inout parameter.
`protected abstract void`	`reportSqlError(java.sql.SQLException error)` Spool information about an SQL error to debug or standard output.
`boolean`	`resultWasNull()` Check if result from last fetched value from executed statement was null.
`protected void`	`setDouble(int colNr, double value)` Bind double parameter.
`void`	`setFetchSize(int size)` Set pre-fetch size to use on this statement.
`void`	`setMaxRows(int max)` Set maximum number of rows to fetch.
`void`	`setRecursive()` Indicates that this statement is a recursive, framework generated, statement.
`void`	`setSpoolPlsqlTrace(boolean on)` Enable or disable spooling of PL/SQL trace.
`protected abstract void`	`setTimestamp(int colNr, java.sql.Timestamp value)` Bind Timestamp parameter as Oracle DATE type.
`protected void`	`spoolPlSqlTrace()` Spool trace from PlSql call to the database logger.
`boolean`	`supportsDefineColumnType()` Check if this statement supports defineColumnType-functionality.
`protected int`	`toJavaSqlType(FndSqlType type)` Convert a FndSqlType to it's corresponding Java SQL type

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - callable
```
protected boolean callable
```
    Flag indicating if the statement is a procedure call.
  - parameters
```
protected java.util.List<FndSqlValue> parameters
```
    List of parameters.
  - stmt
```
protected java.sql.PreparedStatement stmt
```
    Internal statement.
  - c
```
protected java.sql.Connection c
```
    Internal connection.
  - result
```
protected FndResultSet result
```
    Internal result set.
  - log
```
protected Logger log
```
    Database logger
  - utcCalendar
```
protected final java.util.Calendar utcCalendar
```
    Create a calendar object for TimeStamps to be in UTC Time
  - DEFAULT_BUFFER_SIZE
```
protected static final int DEFAULT_BUFFER_SIZE
```
    Default Buffer Size (65536)
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FndStatement
```
protected FndStatement(FndConnection fndConnection)
```
    Creates a new instance of FndStatement
    
    Parameters:
    
    fndConnection -
- Method Detail
  - recreateLogger
```
public void recreateLogger()
```
    Recreates the logger stored in a protected instance variable. This method should be called on an instance of FndStatement that is used by different threads.
  - isShortClobParameter
```
protected boolean isShortClobParameter(int pos)
```
    Checks if the parameter bound at the specified position is a short (less than 32K) CLOB.
    
    Parameters:
    
    pos - 1-based positions of a bind variable
    
    Returns:
    
    true for short CLOB parameter, false otherwise
  - clearFetchedSize
```
public void clearFetchedSize()
```
    Clears the internal counter with approximate number of bytes fetched by query operation.
  - getFetchedSize
```
public long getFetchedSize()
```
    Gets approximate number of bytes fetched by query operation.
    
    Returns:
  - getFndConnection
```
protected FndConnection getFndConnection()
```
    Gets the instance of FndConnection that owns this statement.
    
    Returns:
    
    an instance of FndConnection that created this FndStatement
  - abort
```
public final void abort()
                 throws SystemException
```
    Attempt to abort an executing statement. This method must be called from a thread other than the one executing the statement.
    
    Specified by:
    
    abort in interface ifs.fnd.sf.admin.FndAbortableProcess
    
    Throws:
    
    SystemException
  - spoolPlSqlTrace
```
protected void spoolPlSqlTrace()
                        throws IfsException
```
    Spool trace from PlSql call to the database logger. Override for Oracle.
    
    Throws:
    
    IfsException
  - checkError
```
protected abstract void checkError(java.sql.SQLException e)
                            throws IfsException
```
    Check if the original error should be re-thrown as some other kind of error.
    
    Parameters:
    
    e - Original exception thrown from database
    
    Throws:
    
    IfsException - May re-throw the exception.
  - setSpoolPlsqlTrace
```
public void setSpoolPlsqlTrace(boolean on)
```
    Enable or disable spooling of PL/SQL trace. By default the spooling is enabled if DatabeseLogger level is set to trace or debug. The method is called from a subclass to avoid infinite loop.
    
    Parameters:
    
    on - true to enable spooling of PL/SQL trace, false to disable.
  - setFetchSize
```
public void setFetchSize(int size)
                  throws IfsException
```
    Set pre-fetch size to use on this statement.
    
    Parameters:
    
    size - Pre-fetch size (number of rows)
    
    Throws:
    
    IfsException
  - setMaxRows
```
public void setMaxRows(int max)
                throws IfsException
```
    Set maximum number of rows to fetch.
    
    Parameters:
    
    max - Maximum number of rows.
    
    Throws:
    
    IfsException
  - clearParameters
```
public void clearParameters()
```
    Clear previously defined parameters. (Only the list of parameters is cleared, not bound parameters of already prepared statements.)
  - clearParameters
```
public void clearParameters(int index)
```
    Clear previously defined parameters beginning at the specified index. (Only the list of parameters is modified, not bound parameters of already prepared statements.)
    
    Parameters:
    
    index - the index of the first parameter to be cleared.
  - debugNull
```
protected void debugNull(FndSqlValue val,
                         int colNr)
```
    Used to debug null valued bind parameter.
    
    Parameters:
    
    val - Value of bind parameter
    
    colNr - Bind parameter column number in statement
  - nativeSql
```
protected java.lang.String nativeSql(java.lang.String sql)
```
    Convert sql string to native sql (as translated by the driver).
    
    Parameters:
    
    sql - String containing SQL string.
    
    Returns:
    
    Native SQL.
  - nativeSql
```
protected java.lang.String nativeSql(FndAutoString sql)
```
    Convert sql string to native sql (as translated by the driver).
    
    Parameters:
    
    sql - FndAutoString containing SQL string.
    
    Returns:
    
    Native SQL.
  - setTimestamp
```
protected abstract void setTimestamp(int colNr,
                                     java.sql.Timestamp value)
                              throws IfsException
```
    Bind Timestamp parameter as Oracle DATE type. JDBC driver maps JDBC type TIMESTAMP to Oracle type TIMESTAMP, which contains more information than Oracle DATE type (TIMESTAMP includes nanoseconds and DATE does not). As a result queries using JDBC timestamp bind-variables don't use indexes on DATE columns. This method workarounds this problem by calling setDATE on OraclePreparedStatement.
    
    Parameters:
    
    colNr - column number.
    
    value - parameter value.
    
    Throws:
    
    IfsException
  - setDouble
```
protected void setDouble(int colNr,
                         double value)
                  throws IfsException,
                         java.sql.SQLException
```
    Bind double parameter.
    
    Parameters:
    
    colNr - column number.
    
    value - parameter value.
    
    Throws:
    
    IfsException
    
    java.sql.SQLException
  - bindArguments
```
protected void bindArguments()
                      throws IfsException,
                             java.sql.SQLException
```
    Bind arguments to statement and register out parameters (if any).
    
    Throws:
    
    IfsException
    
    java.sql.SQLException
  - registerOutParameter
```
protected void registerOutParameter(FndSqlValue param,
                                    int parameterIndex)
                             throws IfsException
```
    Register a out/inout parameter.
    
    Parameters:
    
    param - Parameter to register as an out parameter
    
    parameterIndex - index position of parameter in procedure call
    
    Throws:
    
    IfsException
  - prepareCall
```
public void prepareCall(java.lang.String sql)
                 throws IfsException
```
    Prepare a procedure call.
    
    Parameters:
    
    sql - SQL string
    
    Throws:
    
    IfsException
  - prepareCall
```
public void prepareCall(FndAutoString sql)
                 throws IfsException
```
    Prepare a procedure call.
    
    Parameters:
    
    sql - SQL string buffer.
    
    Throws:
    
    IfsException
  - prepare
```
public void prepare(FndAutoString sql)
             throws IfsException
```
    Prepare SQL statement.
    
    Parameters:
    
    sql - SQL string buffer.
    
    Throws:
    
    IfsException
  - prepare
```
public void prepare(java.lang.String sql)
             throws IfsException
```
    Prepare SQL statement.
    
    Parameters:
    
    sql - SQL string.
    
    Throws:
    
    IfsException
  - prepare
```
public void prepare(FndAutoString sql,
                    boolean updateable)
             throws IfsException
```
    Prepare SQL statement and control if resultset should be updateable or not.
    
    Parameters:
    
    sql - SQL string buffer.
    
    updateable - Indicates if resultset should be updateable or not.
    
    Throws:
    
    IfsException
  - prepare
```
public void prepare(java.lang.String sql,
                    boolean updateable)
             throws IfsException
```
    Prepare SQL statement and control if resultset should be updateable or not.
    
    Parameters:
    
    sql - SQL string.
    
    updateable - Indicates if resultset should be updateable or not.
    
    Throws:
    
    IfsException
  - prepareStatement
```
protected void prepareStatement(FndAutoString sql,
                                boolean updateable)
                         throws IfsException
```
    Prepare SQL statement.
    
    Parameters:
    
    sql - SQL string.
    
    updateable - Flag controlling if result set should be updateable or not.
    
    Throws:
    
    IfsException
  - prepareStatement
```
protected void prepareStatement(java.lang.String sql,
                                boolean updateable)
                         throws IfsException
```
    Prepare SQL statement.
    
    Parameters:
    
    sql - SQL string.
    
    updateable - Flag controlling if result set should be updateable or not.
    
    Throws:
    
    IfsException
  - executeQuery
```
public final void executeQuery()
                        throws IfsException
```
    Execute SQL query and register this statement as an abortable process.
    
    Throws:
    
    IfsException
  - executeQuery
```
public final void executeQuery(boolean registerAsAbortableProcess)
                        throws IfsException
```
    Execute SQL query.
    
    Parameters:
    
    registerAsAbortableProcess - flag indicating if this statement should be registered on FndProcessList as an abortable process
    
    Throws:
    
    IfsException
  - executeUpdate
```
public final int executeUpdate()
                        throws IfsException
```
    Execute SQL update/insert/delete.
    
    Returns:
    
    Throws:
    
    IfsException - an error occurs in the driver/database.
  - execute
```
public final boolean execute()
                      throws IfsException
```
    Execute any kind of statement.
    
    Returns:
    
    TRUE if the first result is a ResultSet object, false if no result or if the first result is an update.
    
    Throws:
    
    IfsException
  - execute
```
public final boolean execute(boolean registerAsAbortableProcess)
                      throws IfsException
```
    Execute any kind of statement.
    
    Parameters:
    
    registerAsAbortableProcess - Should this statement be abortable (using Abort Request from client)?
    
    Returns:
    
    TRUE if the first result is a ResultSet object, false if no result or if the first result is an update.
    
    Throws:
    
    IfsException
  - getResult
```
public java.sql.ResultSet getResult()
                             throws SystemException
```
    Deprecated. use getFndResult() instead
    
    Get result set from executed statement.
    
    Returns:
    
    result from executed query.
    
    Throws:
    
    SystemException - if result is null.
    
    See Also:
    
    getFndResult()
  - getFndResult
```
public FndResultSet getFndResult()
                          throws SystemException
```
    Get result set from executed statement.
    
    Returns:
    
    result from executed query.
    
    Throws:
    
    SystemException - if result is null.
  - resultWasNull
```
public boolean resultWasNull()
                      throws IfsException
```
    Check if result from last fetched value from executed statement was null.
    
    Returns:
    
    true if result was null, false otherwise.
    
    Throws:
    
    IfsException
  - close
```
public void close()
           throws SystemException
```
    Close internal JDBC statement.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    SystemException
  - defineInParameter
```
public void defineInParameter(FndAttribute attr)
                       throws SystemException
```
    Bind an argument (attribute value).
    
    Parameters:
    
    attr - Source attribute (Parameter direction set to In.)
    
    Throws:
    
    SystemException
  - defineInParameter
```
public void defineInParameter(FndSqlValue value)
                       throws SystemException
```
    Bind an argument.
    
    Parameters:
    
    value - Bind argument value (parameter direction will be set to In.)
    
    Throws:
    
    SystemException
  - defineParameter
```
public void defineParameter(FndSqlValue value)
```
    Define a parameter.
    
    Parameters:
    
    value - Parameter value. (Parameter direction set on value will be used.)
  - defineOutParameter
```
public void defineOutParameter(java.lang.String name,
                               FndSqlType type)
                        throws SystemException
```
    Define an out parameter for a procedure call.
    
    Parameters:
    
    name - Parameter name
    
    type - Type returned in this parameter
    
    Throws:
    
    SystemException
  - defineInOutParameter
```
public void defineInOutParameter(FndSqlValue value)
                          throws SystemException
```
    Define an inout parameter for a procedure call.
    
    Parameters:
    
    value - Value of inparameter.
    
    Throws:
    
    SystemException
  - checkResult
```
public void checkResult()
                 throws SystemException
```
    Verify that a result exists.
    
    Throws:
    
    SystemException - if null.
  - getString
```
public java.lang.String getString(int colNr)
                           throws IfsException
```
    Get column (string) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getString in interface FndSqlData
    
    Parameters:
    
    colNr - index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    IfsException
  - getOutString
```
protected java.lang.String getOutString(int parameterIndex)
                                 throws java.sql.SQLException
```
    Get an out-parameter value.
    
    Parameters:
    
    parameterIndex -
    
    Returns:
    
    Value of the out parameter
    
    Throws:
    
    java.sql.SQLException
  - getText
```
public java.lang.String getText(int colNr)
                         throws IfsException
```
    Get column (text) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getText in interface FndSqlData
    
    Parameters:
    
    colNr - index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    IfsException
  - getBoolean
```
public boolean getBoolean(int colNr)
                   throws IfsException
```
    Get column (boolean) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getBoolean in interface FndSqlData
    
    Parameters:
    
    colNr - index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    IfsException
  - getOutBoolean
```
protected boolean getOutBoolean(int parameterIndex)
                         throws java.sql.SQLException
```
    Get a out-parameter value
    
    Parameters:
    
    parameterIndex -
    
    Returns:
    
    Value of the parameter
    
    Throws:
    
    java.sql.SQLException
  - getBufferSize
```
protected int getBufferSize(java.sql.Blob blob)
```
    Get the buffer size to use when reading Blob. (Override for every supported database server.)
    
    Parameters:
    
    blob - Blob to get optimal buffer size for.
    
    Returns:
    
    65536 (default value).
  - getBinary
```
public byte[] getBinary(int colNr)
                 throws IfsException
```
    Get column (binary) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getBinary in interface FndSqlData
    
    Parameters:
    
    colNr - index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    SystemException
    
    IfsException
  - getBinary
```
public boolean getBinary(int colNr,
                         FndOutputStreamManager outputMgr)
                  throws IfsException
```
    Get column (binary) value from database into a stream.
    
    Specified by:
    
    getBinary in interface FndSqlData
    
    Parameters:
    
    colNr - column index number.
    
    outputMgr - an output stream manager that controlls streaming of data from the database
    
    Returns:
    
    true if not null binaray data has been written to the stream, false otherwise
    
    Throws:
    
    IfsException
  - getLongRaw
```
public byte[] getLongRaw(int colNr)
                  throws IfsException
```
    Get column (binary) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getLongRaw in interface FndSqlData
    
    Parameters:
    
    colNr - index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    SystemException
    
    IfsException
  - getOutLongRaw
```
protected byte[] getOutLongRaw(int parameterIndex)
                        throws java.sql.SQLException
```
    Get a out-parameter value
    
    Parameters:
    
    parameterIndex -
    
    Returns:
    
    Value of the parameter
    
    Throws:
    
    java.sql.SQLException
  - getDate
```
public java.sql.Date getDate(int colNr)
                      throws IfsException
```
    Get column (date) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getDate in interface FndSqlData
    
    Parameters:
    
    colNr - index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    SystemException
    
    IfsException
  - getOutDate
```
protected java.sql.Date getOutDate(int parameterIndex)
                            throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - getBigDecimal
```
public java.math.BigDecimal getBigDecimal(int colNr)
                                   throws IfsException
```
    Get column (decimal) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getBigDecimal in interface FndSqlData
    
    Parameters:
    
    colNr - index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    IfsException
  - getOutBigDecimal
```
protected java.math.BigDecimal getOutBigDecimal(int parameterIndex)
                                         throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - getLong
```
public long getLong(int colNr)
             throws IfsException
```
    Get column (long) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getLong in interface FndSqlData
    
    Parameters:
    
    colNr - Column index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    IfsException
  - getOutLong
```
protected long getOutLong(int parameterIndex)
                   throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - getInt
```
public int getInt(int colNr)
           throws IfsException
```
    Get column (int) value from database (can only be used after executeQuery).
    
    Parameters:
    
    colNr - Column index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    IfsException
  - getOutInt
```
protected int getOutInt(int parameterIndex)
                 throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - getDouble
```
public double getDouble(int colNr)
                 throws IfsException
```
    Get column (double) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getDouble in interface FndSqlData
    
    Parameters:
    
    colNr - index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    IfsException
  - getOutDouble
```
protected double getOutDouble(int parameterIndex)
                       throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - getBufferSize
```
protected int getBufferSize(java.sql.Clob clob)
```
    Get the buffer size to use when reading Clob. (Override for every supported database server.)
    
    Parameters:
    
    clob - Clob to get buffer size for.
    
    Returns:
    
    32768
  - getLongText
```
public java.lang.String getLongText(int colNr)
                             throws IfsException
```
    Get column (long text) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getLongText in interface FndSqlData
    
    Parameters:
    
    colNr - index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    IfsException
  - getLongTextImpl
```
protected java.lang.String getLongTextImpl(int colNr)
                                    throws IfsException
```
    Throws:
    
    IfsException
  - getTime
```
public java.sql.Time getTime(int colNr)
                      throws IfsException
```
    Get column (time) value from database (can only be used after executeQuery).
    
    Specified by:
    
    getTime in interface FndSqlData
    
    Parameters:
    
    colNr - index number.
    
    Returns:
    
    Value from database.
    
    Throws:
    
    IfsException
  - getOutTime
```
protected java.sql.Time getOutTime(int parameterIndex)
                            throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - getTimestamp
```
public java.sql.Timestamp getTimestamp(int colNr)
                                throws IfsException
```
    Get timestamp value from a executed statement or procedure call.
    
    Specified by:
    
    getTimestamp in interface FndSqlData
    
    Parameters:
    
    colNr - Column/parameter position in statement/procedure call
    
    Returns:
    
    Result value
    
    Throws:
    
    IfsException
  - getOutTimestamp
```
protected java.sql.Timestamp getOutTimestamp(int parameterIndex)
                                      throws java.sql.SQLException
```
    Get timestamp value from an out parameter.
    
    Parameters:
    
    parameterIndex - Parameter position in procedure call.
    
    cal -
    
    Returns:
    
    Value of the out parameter.
    
    Throws:
    
    java.sql.SQLException
  - getCursor
```
public java.sql.ResultSet getCursor(int parameterIndex)
                             throws IfsException
```
    Deprecated. use getFndCursor() instead
    
    Get Ref Cursor value from a procedure call.
    
    Parameters:
    
    parameterIndex - Parameter position in procedure call.
    
    Returns:
    
    ResultSet with query result corresponding to the cursor
    
    Throws:
    
    IfsException
    
    See Also:
    
    getFndCursor(int)
  - getFndCursor
```
public FndResultSet getFndCursor(int parameterIndex)
                          throws IfsException
```
    Get Ref Cursor value from a procedure call.
    
    Parameters:
    
    parameterIndex - Parameter position in procedure call.
    
    Returns:
    
    ResultSet with query result corresponding to the cursor
    
    Throws:
    
    IfsException
  - formatSize
```
protected java.lang.String formatSize(int size)
```
    Formats size into a String.
    
    Parameters:
    
    size - Number of bytes.
    
    Returns:
  - getBlob
```
protected java.sql.Blob getBlob(int colNr)
                         throws IfsException
```
    Get Blob locator.
    
    Parameters:
    
    colNr - Column number in statement
    
    Returns:
    
    BLOB locator
    
    Throws:
    
    IfsException
  - getClob
```
protected java.sql.Clob getClob(int colNr)
                         throws IfsException
```
    Get Clob locator.
    
    Parameters:
    
    colNr - Column number in statement.
    
    Returns:
    
    CLOB locator
    
    Throws:
    
    IfsException
  - toJavaSqlType
```
protected int toJavaSqlType(FndSqlType type)
                     throws SystemException
```
    Convert a FndSqlType to it's corresponding Java SQL type
    
    Parameters:
    
    type - Source FndSqlType
    
    Returns:
    
    Java SQL type
    
    Throws:
    
    SystemException
  - parameterWasNull
```
public boolean parameterWasNull()
                         throws IfsException
```
    Retrieves whether the last OUT parameter read had the value of SQL NULL. Note that this method should be called only after calling a getter method; otherwise, there is no value to use in determining whether it is null or not.
    
    Returns:
    
    true if the last read OUT parameter had the SQL value NULL.
    
    Throws:
    
    IfsException
  - getMessage
```
protected java.lang.String getMessage(java.lang.Exception e)
```
    Returns error message for given Exception removing white space from both ends of the string. Also, this method removes DataDirect specific prefix from SQL error messages.
    
    Parameters:
    
    e -
    
    Returns:
  - reportSqlError
```
protected abstract void reportSqlError(java.sql.SQLException error)
```
    Spool information about an SQL error to debug or standard output.
    
    Parameters:
    
    error - error to be reported
  - supportsDefineColumnType
```
public boolean supportsDefineColumnType()
```
    Check if this statement supports defineColumnType-functionality.
    
    Returns:
    
    true
  - defineRefCursorVariable
```
public boolean defineRefCursorVariable()
```
    Check if REF CURSOR bind variable should be registered as OUT parameter.
    
    Returns:
    
    true
  - closeRefCursorStatement
```
public boolean closeRefCursorStatement()
```
    Check if the statement that returned a REF CURSOR should be closed after retrieving the cursor.
    
    Returns:
    
    true
  - getRefCursor
```
public FndRefCursor getRefCursor()
                          throws IfsException
```
    Retrieves the REF CURSOR returned by this statement.
    
    Returns:
    
    an instance of FndRefCursor encapsulating the cursor returned from the database
    
    Throws:
    
    IfsException
  - getSqlText
```
public final java.lang.String getSqlText()
```
    Returns:
    
    the sqlText
  - setRecursive
```
public void setRecursive()
```
    Indicates that this statement is a recursive, framework generated, statement.

Class FndStatement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

callable

parameters

stmt

c

result

log

utcCalendar

DEFAULT_BUFFER_SIZE

Constructor Detail

FndStatement

Method Detail

recreateLogger

isShortClobParameter

clearFetchedSize

getFetchedSize

getFndConnection

abort

spoolPlSqlTrace

checkError

setSpoolPlsqlTrace

setFetchSize

setMaxRows

clearParameters

clearParameters

debugNull

nativeSql

nativeSql

setTimestamp

setDouble

bindArguments

registerOutParameter

prepareCall

prepareCall

prepare

prepare

prepare

prepare

prepareStatement

prepareStatement

executeQuery

executeQuery

executeUpdate

execute

execute

getResult

getFndResult

resultWasNull

close

defineInParameter

defineInParameter

defineParameter

defineOutParameter

defineInOutParameter

checkResult

getString

getOutString

getText

getBoolean

getOutBoolean

getBufferSize

getBinary

getBinary

getLongRaw

getOutLongRaw

getDate

getOutDate

getBigDecimal

getOutBigDecimal

getLong

getOutLong

getInt

getOutInt

getDouble

getOutDouble