Hitachi

Hitachi Microservices Platform - Paxos Commit Transaction Orchestrator ユーザーズガイド


7.3.7 PctoCallableStatementクラス(SQL-Participant限定)

説明

SQLストアド・プロシージャを実行するときに使用するクラスです。

JDBC APIは、ストアド・プロシージャのSQLエスケープ構文を提供します。これによって、すべてのRDBMSに対して標準の方法でストアド・プロシージャを呼び出せます。SQLエスケープ構文には、結果パラメタを含める場合と、含めない場合があります。結果パラメタを含める場合は、結果パラメタをOUTパラメタとして登録しておく必要があります。そのほかのパラメタは、入力または出力、あるいはその両方に対して使用できます。パラメタは、番号によって順番に参照されます。最初のパラメタは1です。

INパラメタ値は、PreparedStatementから継承したsetメソッドを使用して設定されます。すべてのOUTパラメタの型は、ストアド・プロシージャの実行前に登録する必要があります。実行後に、それらの値はここで提供されるgetメソッド経由で取り出されます。

CallableStatementは、1つのResultSetオブジェクトまたは複数のResultSetオブジェクトを返すことができます。複数のResultSetオブジェクトは、Statementから継承した操作を使用して処理されます。

移植性を高めるには出力パラメタを取得する前に、呼び出しのResultSetオブジェクトと更新カウントを処理するようにします。

メソッド

PctoCallableStatementクラスのメソッドの一覧を次の表に示します。

表7‒15 PctoCallableStatementクラスのメソッドの一覧

メソッド

説明

getArray(int parameterIndex)

指定されたJDBC ARRAYパラメタの値を、Javaプログラミング言語のjava.sql.Arrayオブジェクトとして取り出します。

getBigDecimal(int parameterIndex, int scale)

指定されたJDBC NUMERICパラメタの値を、引数scaleで指定された小数点以下の桁数を持つjava.math.BigDecimalオブジェクトとして取り出します。

getBlob(int parameterIndex)

指定されたJDBC BLOBパラメタの値を、Javaプログラミング言語のjava.sql.Blobオブジェクトとして取り出します。

getBytes(int parameterIndex)

指定されたJDBC BINARYまたはVARBINARYパラメタの値を、Javaプログラミング言語のbyte値の配列として取り出します。

getClob(int parameterIndex)

指定されたJDBC CLOBパラメタの値を、Javaプログラミング言語のjava.sql.Clobオブジェクトとして取り出します。

getDate(int parameterIndex)

指定されたJDBC DATEパラメタの値を、java.sql.Dateオブジェクトとして取り出します。

getDouble(int parameterIndex)

指定されたJDBC DOUBLEパラメタの値を、Javaプログラミング言語のdoubleとして取り出します。

getFloat(int parameterIndex)

指定されたJDBC FLOATパラメタの値を、Javaプログラミング言語のfloatとして取り出します。

getInt(int parameterIndex)

指定されたJDBC INTEGERパラメタの値を、Javaプログラミング言語のintとして取り出します。

getLong(int parameterIndex)

指定されたJDBC BIGINTパラメタの値を、Javaプログラミング言語のlongとして取り出します。

getNString(int parameterIndex)

指定されたNCHAR、NVARCHAR、またはLONGNVARCHARパラメタの値を、Javaプログラミング言語のStringとして取り出します。

getObject(int parameterIndex)

指定されたパラメタの値を、Javaプログラミング言語のObjectとして取り出します。

getObject(int parameterIndex, Class<T> type)

OUTパラメタparameterIndexの値を表すオブジェクトを返します。変換がサポートされている場合は、そのパラメタのSQL型を要求されたJavaデータ型に変換します。

getShort(int parameterIndex)

指定されたJDBC SMALLINTパラメタの値を、Javaプログラミング言語のshortとして取り出します。

getSQLXML(int parameterIndex)

指定されたSQL XMLパラメタの値を、Javaプログラミング言語のjava.sql.SQLXMLオブジェクトとして取り出します。

getString(int parameterIndex)

指定されたJDBC CHAR、VARCHAR、またはLONGVARCHARパラメタの値を、Javaプログラミング言語のStringとして取り出します。

getTime(int parameterIndex)

指定されたJDBC TIMEパラメタの値を、java.sql.Timeオブジェクトとして取り出します。

getTimestamp(int parameterIndex)

指定されたJDBC TIMESTAMPパラメタの値を、java.sql.Timestampオブジェクトとして取り出します。

registerOutParameter(int parameterIndex, int sqlType)

引数parameterIndexに指定したOUTパラメタを、JDBC型sqlTypeとして登録します。

registerOutParameter(int parameterIndex, int sqlType, int scale)

引数parameterIndexに指定したOUTパラメタを、JDBC型sqlTypeとして登録します。

registerOutParameter(int parameterIndex, int sqlType, java.lang.String typeName)

指定された出力パラメタを登録します。

wasNull()

最後に読み込まれたOUTパラメタの値がSQL NULLかどうかを取得します。

PctoPreparedStatementクラスから継承されたPctoCallableStatementクラスのメソッドの一覧を次の表に示します。

表7‒16 PctoPreparedStatementクラスから継承されたPctoCallableStatementクラスのメソッドの一覧

メソッド

説明

addBatch()

詳細については、「(1) addBatch()」を参照してください。

execute()

詳細については、「(2) execute()」を参照してください。

PctoStatementクラスから継承されたPctoCallableStatementクラスのメソッドの一覧を次の表に示します。

表7‒17 PctoStatementクラスから継承されたPctoCallableStatementクラスのメソッドの一覧

メソッド

説明

close()

詳細は「(2) close()」を参照してください。

getUpdateCount()

詳細については、「(14) getUpdateCount()」を参照してください。

パッケージ名称

jp.co.Hitachi.soft.hmppcto.jdbc.client

〈この項の構成〉

(1) getArray(int parameterIndex)

説明

指定されたJDBC ARRAYパラメタの値を、Javaプログラミング言語のjava.sql.Arrayオブジェクトとして取り出します。

形式
public java.sql.Array getArray(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

Javaプログラミング言語のjava.sql.Arrayオブジェクトとして表されたパラメタ値を返します。値が存在しない場合は、nullを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

java.sql.SQLFeatureNotSupportedException:

ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(2) getBigDecimal(int parameterIndex, int scale)

説明

指定されたJDBC NUMERICパラメタの値を、引数scaleで指定された小数点以下の桁数を持つjava.math.BigDecimalオブジェクトとして取り出します。

形式
public java.math.BigDecimal getBigDecimal(int parameterIndex, int scale) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

int scale:

小数点以下の桁数を指定します。

戻り値

パラメタ値を返します。値が存在しない場合は、nullを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

java.sql.SQLFeatureNotSupportedException:

ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(3) getBlob(int parameterIndex)

説明

指定されたJDBC BLOBパラメタの値を、Javaプログラミング言語のjava.sql.Blobオブジェクトとして取り出します。

形式
public java.sql.Blob getBlob(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

Javaプログラミング言語のjava.sql.Blobオブジェクトとして表されたパラメタ値を返します。値が存在しない場合は、nullを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

java.sql.SQLFeatureNotSupportedException:

ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(4) getBytes(int parameterIndex)

説明

指定されたJDBC BINARYまたはVARBINARYパラメタの値を、Javaプログラミング言語のbyte値の配列として取り出します。

形式
public byte[] getBytes(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

パラメタ値を返します。値がSQL NULLの場合は、nullを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(5) getClob(int parameterIndex)

説明

指定されたJDBC CLOBパラメタの値を、Javaプログラミング言語のjava.sql.Clobオブジェクトとして取り出します。

形式
public java.sql.Clob getClob(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

Javaプログラミング言語のjava.sql.Clobオブジェクトとして表されたパラメタ値を返します。値が存在しない場合は、nullを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

java.sql.SQLFeatureNotSupportedException:

ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(6) getDate(int parameterIndex)

説明

指定されたJDBC DATEパラメタの値を、java.sql.Dateオブジェクトとして取り出します。

形式
public java.sql.Date getDate(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

パラメタ値を返します。値が存在しない場合は、nullを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(7) getDouble(int parameterIndex)

説明

指定されたJDBC DOUBLEパラメタの値を、Javaプログラミング言語のdoubleとして取り出します。

形式
public double getDouble(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

パラメタ値を返します。値が存在しない場合は、0を返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(8) getFloat(int parameterIndex)

説明

指定されたJDBC FLOATパラメタの値を、Javaプログラミング言語のfloatとして取り出します。

形式
public float getFloat(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

パラメタ値を返します。値が存在しない場合は、0を返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(9) getInt(int parameterIndex)

説明

指定されたJDBC INTEGERパラメタの値を、Javaプログラミング言語のintとして取り出します。

形式
public int getInt(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

パラメタ値を返します。値が存在しない場合は、0を返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(10) getLong(int parameterIndex)

説明

指定されたJDBC BIGINTパラメタの値を、Javaプログラミング言語のlongとして取り出します。

形式
public long getLong(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

パラメタ値を返します。値が存在しない場合は、0を返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(11) getNString(int parameterIndex)

説明

指定されたNCHAR、NVARCHAR、またはLONGNVARCHARパラメタの値を、Javaプログラミング言語のStringとして取り出します。

固定長の型のJDBC NCHARの場合、返されるStringオブジェクトは、データベースでSQL NCHAR値が持っていた値と正確に同じ値(データベースが付加するパディングを含む)を持ちます。

形式
public java.lang.String getNString(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

NCHAR、NVARCHAR、またはLONGNVARCHAR値をマッピングするStringオブジェクトを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

java.sql.SQLFeatureNotSupportedException:

ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(12) getObject(int parameterIndex)

説明

指定されたパラメタの値を、Javaプログラミング言語のObjectとして取り出します。値がSQL NULLの場合、JDBC DriverはJava nullを返します。

このメソッドは、Javaオブジェクトを返します。そのオブジェクトの型は、registerOutParameterメソッドを使用してこのパラメタに登録されたJDBCの型に対応します。

HMP-PCTOは、ターゲットのJDBCの型をjava.sql.Types.OTHERとして登録するデータベース固有の抽象データ型には対応していません。

形式
public java.lang.Object getObject(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

OUTパラメタ値を保持するjava.lang.Objectオブジェクトを返します。値が存在しない場合は、nullを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(13) getObject(int parameterIndex, Class<T> type)

説明

OUTパラメタparameterIndexの値を表すオブジェクトを返します。変換がサポートされている場合は、そのパラメタのSQL型を要求されたJavaデータ型に変換します。変換がサポートされていない場合、またはtypeにnullが指定された場合、SQLExceptionがスローされます。

形式
public <T> T getObject(int parameterIndex, Class<T> type) throws java.sql.SQLException
<T> T:

このClassオブジェクトでモデル化されるクラスの型です。

引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

Class<T> type:

指定されたパラメタの変換後のJavaデータ型を表すクラスを指定します。

戻り値

OUTパラメタ値を保持する、引数typeで指定したクラスのインスタンスを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 変換がサポートされていない場合

  • 引数typeがnullの場合

  • 上記以外のエラーが発生した場合

java.sql.SQLFeatureNotSupportedException:

ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(14) getShort(int parameterIndex)

説明

指定されたJDBC SMALLINTパラメタの値を、Javaプログラミング言語のshortとして取り出します。

形式
public short getShort(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

パラメタ値を返します。値が存在しない場合は、0を返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(15) getSQLXML(int parameterIndex)

説明

指定されたSQL XMLパラメタの値を、Javaプログラミング言語のjava.sql.SQLXMLオブジェクトとして取り出します。

形式
public java.sql.SQLXML getSQLXML(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

SQL XML値をマッピングするSQLXMLオブジェクトを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

java.sql.SQLFeatureNotSupportedException:

ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(16) getString(int parameterIndex)

説明

指定されたJDBC CHAR、VARCHAR、またはLONGVARCHARパラメタの値を、Javaプログラミング言語のStringとして取り出します。

固定長の型のJDBC CHARの場合、返されるStringオブジェクトは、データベースでSQL CHAR値が持っていた値と正確に同じ値(データベースが付加するパディングを含む)を持ちます。

形式
public java.lang.String getString(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

パラメタ値を返します。値が存在しない場合は、nullを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(17) getTime(int parameterIndex)

説明

指定されたJDBC TIMEパラメタの値を、java.sql.Timeオブジェクトとして取り出します。

形式
public java.sql.Time getTime(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

パラメタ値を返します。値が存在しない場合は、nullを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(18) getTimestamp(int parameterIndex)

説明

指定されたJDBC TIMESTAMPパラメタの値を、java.sql.Timestampオブジェクトとして取り出します。

形式
public java.sql.Timestamp getTimestamp(int parameterIndex) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

戻り値

パラメタ値を返します。値が存在しない場合は、nullを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(19) registerOutParameter(int parameterIndex, int sqlType)

説明

引数parameterIndexに指定したOUTパラメタを、JDBC型sqlTypeとして登録します。ストアド・プロシージャが実行される前に、すべてのOUTパラメタを登録しておく必要があります。

OUTパラメタ用に引数sqlTypeで指定したJDBCの型は、そのパラメタの値を読み込むためにgetメソッドで使用するJavaの型を判定します。HMP-PCTOは、データベース固有の型には対応していません。sqlTypeにjava.sql.Types.OTHERを指定した場合は、例外を送出します。

パラメタがJDBC型NUMERICまたはDECIMALの場合は、スケール値を受け入れるバージョンのregisterOutParameterを使用します。

形式
public void registerOutParameter(int parameterIndex, int sqlType) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

int sqlType:

java.sql.Typesによって定義されるJDBC型のコードを指定します。

戻り値

なし。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

java.sql.SQLFeatureNotSupportedException:

引数sqlTypeのデータ型が、ARRAY、BLOB、CLOB、DATALINK、JAVA_OBJECT、NCHAR、NCLOB、NVARCHAR、LONGNVARCHAR、REF、ROWID、SQLXML、またはSTRUCTで、ParticipantのJDBC Driverがこのデータ型をサポートしていない場合に送出します。

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(20) registerOutParameter(int parameterIndex, int sqlType, int scale)

説明

引数parameterIndexに指定したOUTパラメタを、JDBC型sqlTypeとして登録します。ストアド・プロシージャが実行される前に、すべてのOUTパラメタを登録しておく必要があります。

OUTパラメタ用に引数sqlTypeで指定したJDBCの型は、そのパラメタの値を読み込むためにgetメソッドで使用するJavaの型を判定します。

パラメタがJDBCの型NUMERICまたはDECIMALの場合は、このregisterOutParameterメソッドを使用します。

形式
public void registerOutParameter(int parameterIndex, int sqlType, int scale) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

int sqlType:

java.sql.Typesによって定義されるSQL型のコードを指定します。

int scale:

設定する小数点以下の桁数を指定します。0以上の数値を指定してください。

戻り値

なし。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

java.sql.SQLFeatureNotSupportedException:

引数sqlTypeのデータ型が、ARRAY、BLOB、CLOB、DATALINK、JAVA_OBJECT、NCHAR、NCLOB、NVARCHAR、LONGNVARCHAR、REF、ROWID、SQLXML、またはSTRUCTで、ParticipantのJDBC Driverがこのデータ型をサポートしていない場合に送出します。

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(21) registerOutParameter(int parameterIndex, int sqlType, java.lang.String typeName)

説明

指定された出力パラメタを登録します。ユーザ定義出力パラメタまたはREF出力パラメタには、このバージョンのregisterOutParameterメソッドを使用してください。ユーザ定義型の例には、STRUCT、DISTINCT、JAVA_OBJECT、および名前付き配列があります。

ストアド・プロシージャが実行される前に、すべてのOUTパラメタを登録しておいてください。

ユーザ定義パラメタの場合は、そのパラメタの完全指定SQL型名も指定してください。REFパラメタの場合は、参照する型の完全指定型名を指定してください。型コードや型名の情報を必要としないParticipantのJDBC Driverはそれを無視します。ただし、移植性を高めるためには、アプリケーションはユーザ定義パラメタおよびREFパラメタに対して、これらの値を提供する必要があります。このメソッドは、ユーザ定義パラメタとREFパラメタを対象としていますが、任意のJDBC型のパラメタを登録するために使用することもできます。パラメタがユーザ定義の型またはREF型を持たない場合、typeNameパラメタは無視されます。

出力パラメタの値を読み込むときには、そのパラメタの登録済みSQL型に対応するJava型用の取得メソッドを使用してください。

形式
public void registerOutParameter(int parameterIndex, int sqlType, java.lang.String typeName) throws java.sql.SQLException
引数
int parameterIndex:

取得したいパラメタのインデックスを指定します。最初のパラメタは1、2番目のパラメタは2、…となります。

int sqlType:

java.sql.Typesの値を指定します。

java.lang.String typeName:

SQL構造化型の完全指定された名前を指定してください。

戻り値

なし。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • 引数が無効な場合

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

java.sql.SQLFeatureNotSupportedException:

引数sqlTypeのデータ型が、ARRAY、BLOB、CLOB、DATALINK、JAVA_OBJECT、NCHAR、NCLOB、NVARCHAR、LONGNVARCHAR、REF、ROWID、SQLXML、またはSTRUCTで、ParticipantのJDBC Driverがこのデータ型をサポートしていない場合に送出します。

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。

(22) wasNull()

説明

最後に読み込まれたOUTパラメタの値がSQL NULLかどうかを取得します。読み込み用メソッドの呼び出しのあとに、このメソッドを呼び出してください。そうでないと、nullかどうかを判別するために使用する値がありません。

形式
public boolean wasNull() throws java.sql.SQLException
引数

なし。

戻り値

最後に読み込まれたパラメタがSQL NULLの場合はtrueを、それ以外の場合はfalseを返します。

例外

PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。

java.sql.SQLException:

次の場合に例外を送出します。

  • データベースアクセスエラーが発生した場合

  • メソッドが、クローズされたCallableStatementで呼び出された場合

PctoCommunicationFailureException:

Entity-ServiceとParticipant間の通信に失敗した場合に送出します。

PctoInternalContradictionException:

Participantの内部で障害が発生した場合に送出します。

PctoTransactionStartException:

トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。