Package de.uplanet.lucy.server.util.db

Interface IDbPreparedStatement

All Superinterfaces:
AutoCloseable, ICloseable
All Known Implementing Classes:
DbPreparedStatement
public interface IDbPreparedStatement extends ICloseable

  • Method Details

    • getFetchSize

      int getFetchSize() throws SQLException
      Get the fetch size of the underlying prepared statement.
      Returns:
      The fetch size.
      Throws:
      SQLException
      See Also:

    • setFetchSize

      void setFetchSize(int p_iFetchSize) throws SQLException
      Set the fetch size of the underlying prepared statement.
      Parameters:
      p_iFetchSize - The fetch size.
      Throws:
      SQLException
      See Also:

    • execute

      void execute() throws SQLException
      Executes the SQL statement in this object, which may be any kind of SQL statement.
      Throws:
      SQLException - If a database error occurred.

    • executeUpdate

      int executeUpdate() throws SQLException
      Executes the SQL statement in this object, which must be an SQL Data Manipulation Language (DML) statement, such as INSERT, UPDATE or DELETE; or an SQL statement that returns nothing, such as a DDL statement.
      Throws:
      SQLException - If a database error occurred.

    • executeQuery

      IDbResultSet executeQuery() throws SQLException
      Executes the SQL query in this object and returns the IDbResultSet object generated by the query.
      Returns:
      An IDbResultSet object that contains the data produced by the query; never null.
      Throws:
      SQLException - If a database error occurred.

    • executeAndGetScalarValueHolder

      IValueHolder<?> executeAndGetScalarValueHolder() throws SQLException
      Get the value of the first column in the first row of the result set.

      If the result set is empty, null is returned.

      Returns:
      A value holder that contains the value of the first column in the first row of the result set, or null if the result set is empty.
      Throws:
      SQLException

    • executeAndGetScalarValue

      Object executeAndGetScalarValue(Object p_valueFallback) throws SQLException
      Get the value of the first column in the first row of the result set.

      If the result set is empty, or the value is null, p_valueIfNull is returned.

      Parameters:
      p_valueFallback - The return value if the query returns an empty result set or null.
      Returns:
      The value of the first column in the first row of the result set, or p_valueIfNull if the result set is empty, or the value is null.
      Throws:
      SQLException

    • executeAndGetScalarValue

      Object executeAndGetScalarValue() throws SQLException
      Get the value of the first column in the first row of the result set.

      If the result set is empty, null is returned.

      Returns:
      The value of the first column in the first row of the result set, or null if the result set is empty.
      Throws:
      SQLException

    • executeAndGetScalarBooleanValue

      Boolean executeAndGetScalarBooleanValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarBooleanValue

      Boolean executeAndGetScalarBooleanValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarByteValue

      Byte executeAndGetScalarByteValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarByteValue

      Byte executeAndGetScalarByteValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarShortValue

      Short executeAndGetScalarShortValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarShortValue

      Short executeAndGetScalarShortValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarIntValue

      Integer executeAndGetScalarIntValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarIntValue

      Integer executeAndGetScalarIntValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarLongValue

      Long executeAndGetScalarLongValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarLongValue

      Long executeAndGetScalarLongValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarFloatValue

      Float executeAndGetScalarFloatValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarFloatValue

      Float executeAndGetScalarFloatValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarDoubleValue

      Double executeAndGetScalarDoubleValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarDoubleValue

      Double executeAndGetScalarDoubleValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarBigDecimalValue

      BigDecimal executeAndGetScalarBigDecimalValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarBigDecimalValue

      BigDecimal executeAndGetScalarBigDecimalValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarStringValue

      String executeAndGetScalarStringValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarStringValue

      String executeAndGetScalarStringValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarTimestampValue

      Timestamp executeAndGetScalarTimestampValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarTimestampValue

      Timestamp executeAndGetScalarTimestampValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarDateValue

      Date executeAndGetScalarDateValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarDateValue

      Date executeAndGetScalarDateValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarTimeValue

      Date executeAndGetScalarTimeValue(Object p_valueFallback) throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue(Object).
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • executeAndGetScalarTimeValue

      Date executeAndGetScalarTimeValue() throws SQLException, ValueCastException
      Typed version of executeAndGetScalarValue().
      Throws:
      SQLException - If a database error occurred.
      ValueCastException - If the database value could not be cast to the specific type.
      See Also:

    • setBoolean

      void setBoolean(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given boolean value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setInt

      void setInt(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given integer number value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setLong

      void setLong(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given integer number value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setShort

      void setShort(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given integer number value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setByte

      void setByte(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given integer value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setBigDecimal

      void setBigDecimal(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given number value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setFloat

      void setFloat(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given floating point number value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setDouble

      void setDouble(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given floating point number value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setTimestamp

      void setTimestamp(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given timestamp value.

      A calendar with the time zone that is associated with the database connection that was used to create this statement is used to write the timestamp to the database.

      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setTimestamp

      void setTimestamp(int p_iIdx, Object p_value, TimeZone p_tz) throws SQLException
      Sets the designated parameter to the given timestamp value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      p_tz - The time zone to be used when writing the timestamp to the database. If this parameter is omitted, the time zone that is associated with the database connection that was used to create this statement is used.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setTimestamp

      void setTimestamp(int p_iIdx, Object p_value, Calendar p_cal) throws SQLException
      Sets the designated parameter to the given timestamp value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      p_cal - The calendar to be used when writing the timestamp to the database. If this parameter is omitted, a calendar with the time zone that is associated with the database connection that was used to create this statement is used.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setTime

      void setTime(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given time value.

      A calendar with the time zone that is associated with the database connection that was used to create this statement is used to write the time value to the database.

      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setTime

      void setTime(int p_iIdx, Object p_value, TimeZone p_tz) throws SQLException
      Sets the designated parameter to the given time value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      p_tz - The time zone to be used when writing the time value to the database. If this parameter is omitted, the time zone that is associated with the database connection that was used to create this statement is used.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setTime

      void setTime(int p_iIdx, Object p_value, Calendar p_cal) throws SQLException
      Sets the designated parameter to the given time value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      p_cal - The calendar to be used when writing the time to the database. If this parameter is omitted, a calendar with the time zone that is associated with the database connection that was used to create this statement is used.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setDate

      void setDate(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given date value.

      A calendar with the time zone that is associated with the database connection that was used to create this statement is used to write the time value to the database.

      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setDate

      void setDate(int p_iIdx, Object p_value, TimeZone p_tz) throws SQLException
      Sets the designated parameter to the given date value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      p_tz - The time zone to be used when writing the date value to the database. If this parameter is omitted, the time zone that is associated with the database connection that was used to create this statement is used.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setDate

      void setDate(int p_iIdx, Object p_value, Calendar p_cal) throws SQLException
      Sets the designated parameter to the given date value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      p_cal - The calendar to be used when writing the date to the database. If this parameter is omitted, a calendar with the time zone that is associated with the database connection that was used to create this statement is used.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setString

      void setString(int p_iIdx, Object p_value) throws SQLException
      Sets the designated parameter to the given string value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.

    • setCharacterStream

      void setCharacterStream(int p_iIdx, Object p_value) throws SQLException, IOException
      Sets the designated parameter to the value given string value.
      Parameters:
      p_iIdx - The first parameter is 1, the second is 2, ...
      p_value - The parameter value.
      Throws:
      SQLException - If the parameter index does not correspond to a parameter marker in the SQL statement, if a database access error occurs, or this method is called on a closed statement.
      IOException

    • close

      void close() throws SQLException
      Close this statement.
      Specified by:
      close in interface AutoCloseable
      Throws:
      SQLException - If a database error occurred.