パッケージ org.opengion.fukurou.business

## クラス BizLogicHelper

- java.lang.Object
- - org.opengion.fukurou.business.BizLogicHelper

-     public class BizLogicHelper
      extends java.lang.Object

  業務ロジックを実行するためのヘルパークラスです。 このクラスの役割は、外部パッケージ(タグクラスなど)からの各種の設定情報を 業務ロジックの実体のクラスにセットすることです。 業務ロジックの実体となるクラス(AbstractBizLogic)では、各種設定情報のセッター メソッドを、サブクラス(各業務ロジックの実装クラス)から隠蔽するため、パッケージ プライベートで定義しています。 このため、外部クラスから、直接設定情報をセットすることができないため、このヘルパー クラスを介して、各種情報をセットしています。
  機能分類
    業務ロジック
  変更履歴:
    5.1.1.0 (2009/12/01) 新規作成
  バージョン
    5.0
  作成者
    Hiroki Nakamura
  導入されたバージョン:
    JDK1.6,

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタ | 説明
    --- | ---
    `BizLogicHelper​(java.lang.String name, HybsLoader ldr)` | コンストラクターを定義しています。

  - ### メソッドの概要

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッド | 説明
    --- | --- | ---
    `boolean` | `exec()` | 処理を実行します。
    `java.lang.String` | `getDebugMsg()` | デバッグメッセージを取得します。
    `ErrorMessage` | `getErrMsg()` | エラーメッセージオブジェクトを返します。
    `int` | `getKekka()` | 結果ステータスを返します。
    `java.lang.String` | `getReturn()` | 業務ロジックの戻り値を返します。
    `java.util.Map<java.lang.String,​java.lang.String>` | `getReturnMap()` | 変数に関連付けた値を、返します。
    `boolean` | `isRequireTable()` | このクラスは、テーブルモデルが外部から指定されている必要はありません。
    `void` | `setDbid​(java.lang.String id)` | 接続先IDを指定します。
    `void` | `setDebug()` | デバッグモードにします。
    `void` | `setKeys​(java.lang.String... ks)` | 固定値のキー配列を指定します。
    `void` | `setLoader​(HybsLoader ldr)` | 業務ロジックのクラスをロードするためのクラスローダーをセットします。
    `void` | `setParentPgId​(java.lang.String id)` | 親(呼び出し)PGIDを指定します。
    `void` | `setTable​(DataModel<java.lang.String> tbl)` | 配列型テーブルモデルをセットします。
    `void` | `setTransaction​(Transaction tran)` | DBのトランザクションオブジェクトを指定します。
    `void` | `setUserId​(java.lang.String id)` | この処理の実行ユーザーIDを指定します。
    `void` | `setVals​(java.lang.String... vs)` | 固定値の値配列を指定します。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### BizLogicHelper

          public BizLogicHelper​(java.lang.String name,
                                HybsLoader ldr)

      コンストラクターを定義しています。
      パラメータ:
        `name` - 業務ロジックのクラス名
        `ldr` - クラスローダー

  - ### メソッドの詳細

    - #### setTransaction

          public void setTransaction​(Transaction tran)

      DBのトランザクションオブジェクトを指定します。 各実装クラスでは、コネクションのcommit,rollbackは行われません。 (全てのDB処理は、1つのトランザクションとして処理されます。) このため、commit,rollbackは呼び出し元で行う必要があります。 このメソッドは、1度しかセットすることができません。2回以上呼び出しするとエラーになります。
      パラメータ:
        `tran` - トランザクション
      変更履歴:
        5.1.9.0 (2010/08/01) 新規作成

    - #### setDbid

          public void setDbid​(java.lang.String id)

      接続先IDを指定します。 このメソッドは、1度しかセットすることができません。2回以上呼び出しするとエラーになります。
      パラメータ:
        `id` - 接続先ID
      変更履歴:
        5.1.9.0 (2010/08/01) 新規作成

    - #### setLoader

          public void setLoader​(HybsLoader ldr)

      業務ロジックのクラスをロードするためのクラスローダーをセットします。 このメソッドは、1度しかセットすることができません。2回以上呼び出しするとエラーになります。
      パラメータ:
        `ldr` - クラスローダー

    - #### setTable

          public void setTable​(DataModel<java.lang.String> tbl)

      配列型テーブルモデルをセットします。 このメソッドは、1度しかセットすることができません。2回以上呼び出しするとエラーになります。
      パラメータ:
        `tbl` - 配列型テーブルモデル
      変更履歴:
        6.7.9.1 (2017/05/19) ArrayTableModel を、DataModel I/F に変更

    - #### setKeys

          public void setKeys​(java.lang.String... ks)

      固定値のキー配列を指定します。 このメソッドは、1度しかセットすることができません。2回以上呼び出しするとエラーになります。
      パラメータ:
        `ks` - キー配列(可変長引数)

    - #### setVals

          public void setVals​(java.lang.String... vs)

      固定値の値配列を指定します。 このメソッドは、1度しかセットすることができません。2回以上呼び出しするとエラーになります。
      パラメータ:
        `vs` - 値配列(可変長引数)

    - #### setUserId

          public void setUserId​(java.lang.String id)

      この処理の実行ユーザーIDを指定します。
      パラメータ:
        `id` - 実行ユーザーID

    - #### setParentPgId

          public void setParentPgId​(java.lang.String id)

      親(呼び出し)PGIDを指定します。
      パラメータ:
        `id` - 親PGID

    - #### setDebug

          public void setDebug()

      デバッグモードにします。

    - #### getDebugMsg

          public java.lang.String getDebugMsg()

      デバッグメッセージを取得します。
      戻り値:
        デバッグメッセージ

    - #### exec

          public boolean exec()
                       throws java.lang.Throwable

      処理を実行します。 処理の方法は、main()メソッドにより定義されます。 実装クラスで発生した全ての例外は、Throwableオブジェクトとしてスローされます。 呼び出し元では、例外を確実にcatchして、commit,rollbackを行ってください。
      戻り値:
        処理が成功したかどうか
      例外:
        `java.lang.Throwable` - 実行時の全エラーを上位に転送します。

    - #### getKekka

          public int getKekka()

      結果ステータスを返します。
      戻り値:
        結果ステータス

    - #### getErrMsg

          public ErrorMessage getErrMsg()

      エラーメッセージオブジェクトを返します。
      戻り値:
        エラーメッセージ

    - #### getReturn

          public java.lang.String getReturn()

      業務ロジックの戻り値を返します。
      戻り値:
        戻り値

    - #### getReturnMap

          public java.util.Map<java.lang.String,​java.lang.String> getReturnMap()

      変数に関連付けた値を、返します。 これは、BizLogicから、呼び出し元のJSPに、RETURN 変数以外の {@XXXX} パラメータを返します。 既存のアトリビュートがあれば、上書きされます。
      戻り値:
        変数に関連付けた値の内部マップオブジェクト
      変更履歴:
        6.9.9.0 (2018/08/20) 戻り値を返せるようにします。

    - #### isRequireTable

          public boolean isRequireTable()

      このクラスは、テーブルモデルが外部から指定されている必要はありません。
      戻り値:
        テーブルモデルが外部からセットされる必要があるかどうか
      関連項目:
        `AbstractBizLogic.isRequireTable()`