com.JRcServer.sql.operation
インタフェース CallableSQL

既知の実装クラスの一覧:
CallableSQLBase, CallableSQLBuffer, CallableSQLDefault

public interface CallableSQL

ストアドプロシジャ実施モード実行.

ストアドプロシジャ実施処理を行う場合、利用します.

導入されたバージョン:
JDK 1.3
バージョン:
1.0.0 2003/11/03
作成者:
masahito suzuki

メソッドの概要
 void addOutParameter(int type)
          取得パラメータの追加.
 void addOutParameter(int type, int scale)
          取得パラメータの追加.
 void addParameter(java.lang.Object info)
          パラメータ追加.
 void addParameterByNull(int type)
          パラメータ追加.
 int executeUpdate()
          SQL実行.
 void execution()
          ストアドプロシジャ実行.
 java.sql.Blob getBlob(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 boolean getBoolean(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 byte getByte(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 byte[] getBytes(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 java.sql.Date getDate(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 java.math.BigDecimal getDecimal(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 double getDouble(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 float getFloat(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 int getInt(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 long getLong(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 boolean getNull(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報がnullであるかチェック.
 java.lang.Object getObject(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 SQLResult getResult()
          内容取得.
 short getShort(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 java.lang.String getString(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 java.sql.Time getTime(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 java.sql.Timestamp getTimestamp(int indexNo)
          ストアドプロシジャ[OUT]パラメータの情報を取得.
 void setCall(java.lang.String call)
          ストアドプロシジャ呼び出し設定.
 void setSQLTypes(SQLTypes types)
          SQLタイプ群情報の設定.
 boolean wasNull()
          直前に読み込まれた情報がnullであるかどうかチェック.
 

メソッドの詳細

setCall

void setCall(java.lang.String call)
             throws InputException,
                    SQLAccessException
ストアドプロシジャ呼び出し設定.

実行対象のストアドプロシジャ呼び出し構文を設定します.

パラメータ:
call - ストアドプロシジャ呼び出し構文を設定します.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

setSQLTypes

void setSQLTypes(SQLTypes types)
                 throws InputException,
                        SQLParameterException
SQLタイプ群情報の設定.

SQLタイプ群情報を設定します.
また、この情報は、[CallableSQL#addParameter()]呼び出しの前に 実施する必要があります.

パラメータ:
types - SQLタイプオブジェクトを設定します.
例外:
InputException - 入力例外.
SQLParameterException - SQLパラメータ例外.

addParameter

void addParameter(java.lang.Object info)
                  throws InputException
パラメータ追加.

対象のパラメータ情報を追加します.

パラメータ:
info - 設定パラメータ情報を設定します.
例外:
InputException - 入力例外.

addParameterByNull

void addParameterByNull(int type)
パラメータ追加.

対象のパラメータ[null]情報を追加します.

パラメータ:
type - 対象のタイプを指定します.

addOutParameter

void addOutParameter(int type)
                     throws InputException
取得パラメータの追加.

取得を行うためのパラメータを設定します.

パラメータ:
type - 取得を行うためのパラメータタイプ(型定義)を 指定します.
定義対象の情報は[java.sql.Types]で定義します.
例外:
InputException - 入力例外.

addOutParameter

void addOutParameter(int type,
                     int scale)
                     throws InputException
取得パラメータの追加.

取得を行うためのパラメータを設定します.

パラメータ:
type - 取得を行うためのパラメータタイプ(型定義)を 指定します.
定義対象の情報は[java.sql.Types]で定義します.
scale - スケール値を設定します.
この情報は、対象情報が[Decimal]及び[NUMERIC]の場合に 利用します.
例外:
InputException - 入力例外.

execution

void execution()
               throws SQLAccessException,
                      SQLParameterException
ストアドプロシジャ実行.

設定されたストアドプロシジャを実行します.

例外:
SQLAccessException - SQLアクセス例外.
SQLParameterException - SQLパラメータ例外.

executeUpdate

int executeUpdate()
                  throws SQLAccessException,
                         SQLParameterException
SQL実行.

準備されたSQL文を実行します. この処理では、戻り情報が存在しない場合のSQL文を実施する場合に 利用します.

戻り値:
int 処理結果の件数が返されます.
例外:
SQLAccessException - SQLアクセス例外.
SQLParameterException - SQLパラメータ例外.

getResult

SQLResult getResult()
                    throws ExecutionException
内容取得.

対象のストアドプロシジャ実行による取得結果を利用する場合に 呼び出します.

戻り値:
SQLResult SQL実施による結果情報が返されます.
例外:
ExecutionException - 実行例外.

getObject

java.lang.Object getObject(int indexNo)
                           throws InputException,
                                  SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
Object 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getString

java.lang.String getString(int indexNo)
                           throws InputException,
                                  SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
String 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getDecimal

java.math.BigDecimal getDecimal(int indexNo)
                                throws InputException,
                                       SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
BigDecimal 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getDate

java.sql.Date getDate(int indexNo)
                      throws InputException,
                             SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
Date 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getTime

java.sql.Time getTime(int indexNo)
                      throws InputException,
                             SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
Time 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getTimestamp

java.sql.Timestamp getTimestamp(int indexNo)
                                throws InputException,
                                       SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
Timestamp 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getBlob

java.sql.Blob getBlob(int indexNo)
                      throws InputException,
                             SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
Blob 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getBytes

byte[] getBytes(int indexNo)
                throws InputException,
                       SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
byte[] 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getBoolean

boolean getBoolean(int indexNo)
                   throws InputException,
                          SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
boolean 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getByte

byte getByte(int indexNo)
             throws InputException,
                    SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
byte 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getShort

short getShort(int indexNo)
               throws InputException,
                      SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
short 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getInt

int getInt(int indexNo)
           throws InputException,
                  SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
int 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getLong

long getLong(int indexNo)
             throws InputException,
                    SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
long 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getFloat

float getFloat(int indexNo)
               throws InputException,
                      SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
float 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getDouble

double getDouble(int indexNo)
                 throws InputException,
                        SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報を取得.

ストアドプロシジャ[OUT]パラメータの情報を取得します.

パラメータ:
indexNo - 指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
double 取得対象の情報が返されます.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

getNull

boolean getNull(int indexNo)
                throws InputException,
                       SQLAccessException
ストアドプロシジャ[OUT]パラメータの情報がnullであるかチェック.

ストアドプロシジャ[OUT]パラメータの情報がnullであるかチェックします.

パラメータ:
indexNo - nullチェック対象の指定カラム位置番号を指定します.
また、このときの取得範囲は(1.2....n)となります.
戻り値:
boolean チェック結果が返されます.
[true]が返された場合、直前に読み込まれた情報はnullです.
[false]が返された場合、直前に読み込まれた情報はnullではありません.
例外:
InputException - 入力例外.
SQLAccessException - SQLアクセス例外.

wasNull

boolean wasNull()
                throws SQLAccessException
直前に読み込まれた情報がnullであるかどうかチェック.

直前に読み込まれた情報がnullであるかどうかチェックします.

戻り値:
boolean チェック結果が返されます.
[true]が返された場合、直前に読み込まれた情報はnullです.
[false]が返された場合、直前に読み込まれた情報はnullではありません.
例外:
SQLAccessException - SQLアクセス例外.