org.opengion.fukurou.transfer

## インタフェース TransferRead

- 既知の実装クラスのリスト:
    TransferRead_CB01, TransferRead_FILELIST, TransferRead_HTTP, TransferRead_HTTP_CB01, TransferRead_HTTP_FILELIST, TransferRead_SAMCB

      public interface TransferRead

       伝送要求に対するの読取方法を定義するインターフェースです。

       各実装クラスでは、読取処理read(TransferConfig, Transaction)
       、完了処理complete(TransferConfig, Transaction)、エラー処理error(TransferConfig, ApplicationInfo)を実装する必要があります。
       サブクラス内部で、DB関連の処理を行う場合は、引数のTransactionオブジェクトを利用して下さい。
       また、接続に対するCommit/Rollbackは、呼び出し元で行いますので、実行処理の中では行わないで下さい。

       また、HTTP経由での実行などで、読取処理とその後の完了/エラー処理でオブジェクトが同一出ない場合に、
       外部から読取キーの取得及び設定を行うことができます。
       具体的には、read(TransferConfig, Transaction)を実行後、getKeys()を呼び出しすることで
       終了処理で処理対象となるキー情報を取得することができます。
       このキー情報を保持し、setKeys(String[])で別オブジェクトに対してキーを設定することで、
       完了処理complete(TransferConfig, Transaction)、エラー処理error(TransferConfig, ApplicationInfo)
       を呼び出しすることができます。

  機能分類
    伝送システム
  バージョン
    5.0
  作成者
    Hiroki.Nakamura
  導入されたバージョン:
    JDK1.6

- - ### メソッドのサマリー

    All Methods Instance Methods Abstract Methods
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `complete(TransferConfig config, Transaction tran)` 完了処理を実行します。
    `void` | `error(TransferConfig config, ApplicationInfo appInfo)` エラー処理を実行します。
    `String[]` | `getKeys()` 更新キー(配列)を返します。
    `String[]` | `read(TransferConfig config, Transaction tran)` 読取処理を実行し、結果をテキストデータの配列として返します。
    `void` | `setKeys(String[] keys)` 更新キー(配列)をセットします。

- - ### メソッドの詳細

    - #### read

          String[] read(TransferConfig config,
                        Transaction tran)

      読取処理を実行し、結果をテキストデータの配列として返します。
      パラメータ:
        `config` - 伝送設定オブジェクト
        `tran` - トランザクションオブジェクト
      戻り値:
        読み取りしたデータ(配列)

    - #### getKeys

          String[] getKeys()

      更新キー(配列)を返します。
      戻り値:
        更新キー(配列)

    - #### setKeys

          void setKeys(String[] keys)

      更新キー(配列)をセットします。
      パラメータ:
        `keys` - 更新キー(配列)

    - #### complete

          void complete(TransferConfig config,
                        Transaction tran)

      完了処理を実行します。 この処理は実行方法で定義された実行処理が正常終了した場合に呼び出しされます。 更新対象のキーについては、`setKeys(String[])`で外部からセットすることもできます。
      パラメータ:
        `config` - 伝送設定オブジェクト
        `tran` - トランザクションオブジェクト

    - #### error

          void error(TransferConfig config,
                     ApplicationInfo appInfo)

      エラー処理を実行します。 この処理は実行方法で定義された実行処理が以上終了した場合に呼び出しされます。 更新対象のキーについては、`setKeys(String[])`で外部からセットすることもできます。
      パラメータ:
        `config` - 伝送設定オブジェクト
        `appInfo` - DB接続情報

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.