IM-FormaDesigner for Accel Platform プログラミングガイド

«  前処理   ::   コンテンツ   ::   PDF出力処理  »

登録データ情報管理API

この章では、アプリケーションの登録データを取得または操作する方法・手順について解説します。
この API で提供するメソッドはアプリケーションのデータをデータベースから取得、操作するものであり、権限によるチェックは行いませんのでご注意ください。

JavaEE開発モデル

アプリケーションデータを登録または検索・削除するための下記のクラスが用意されています。

  • jp.co.intra_mart.foundation.forma.ApplicationDataManager

コンストラクタ

  • コンストラクタ①

    • ApplicationDataManager(String loginUserCd)

      このコンストラクタを利用してマネージャオブジェクトを生成した場合、データ操作を行った際に後処理の設定があった場合は後処理が実行されます。

    • パラメータ

      loginUserCd ログインユーザCD

  • コンストラクタ②

    • ApplicationDataManager(String loginUserCd, boolean execPostProcFlg)

      このコンストラクタを利用してマネージャオブジェクトを生成時にデータ操作を行った際の後処理の実行有無を指定することができます。

    • パラメータ

      loginUserCd ログインユーザCD
      execPostProcFlg 後処理実行フラグ 後処理を実行する場合は true、しない場合は false

主なメソッド

データの取得メソッド

  • Map<String, Object> getItemData (String applicationId, String insertId, boolean systemData)

    指定されたデータ登録 ID の登録情報を返却します。

    • パラメータ

      applicationId アプリケーションID
      insertId 登録データID
      systemData システム情報の取得の有無 取得する場合は true、しない場合は false

    • 返却値

      登録情報マップ
      ※詳細は後述の登録情報マップをご参照ください。

データの登録メソッド

  • void insertItemData(String applicationId, long applicationNo, String insertId, Map<String, Object> itemData)

    アプリケーションの登録情報をテーブルに登録します。

    • パラメータ

      applicationId アプリケーションID
      applicationNo アプリケーションバージョンNO（アプリケーション履歴番号）
      insertId 登録データID
      itemData 登録情報マップ
      ※詳細は後述の登録情報マップをご参照ください。

    • 返却値

      なし

    後処理内でこのメソッドを使用する場合、さらに後処理を実行する必要がない場合はコンストラクタ②の execPostProcFlg を false にしてマネージャオブジェクトを生成してください。

データの更新メソッド

  • void updateItemData(String applicationId, long applicationNo, String insertId, Map<String, Object> itemData)

    指定された登録データID の登録情報を更新します。

    • パラメータ

      applicationId アプリケーションID
      applicationNo アプリケーションバージョンNO（アプリケーション履歴番号）
      insertId 登録データID
      itemData 登録情報マップ
      ※詳細は後述の登録情報マップをご参照ください。

    • 返却値

      なし

    後処理内でこのメソッドを使用する場合、さらに後処理を実行する必要がない場合はコンストラクタ②の execPostProcFlg を false にしてマネージャオブジェクトを生成してください。

データの削除メソッド

  • void deleteItemData(String applicationId, String insertId, long versionNo)

    指定された登録データ ID の登録情報を削除します。

    • パラメータ

      applicationId アプリケーションID
      insertId 登録データID
      versionNo データバージョン番号

    • 返却値

      なし

    後処理内でこのメソッドを使用する場合、さらに後処理を実行する必要がない場合はコンストラクタ②の execPostProcFlg を false にしてマネージャオブジェクトを生成してください。

登録情報マップ

登録情報マップは Map<String, Object>形式で登録情報を保持します。

  • Map<String, Object>

  • 明細テーブル以外のアイテム

    キー ：フィールド識別ID
    値： 入力値

  • 明細テーブルアイテムのデータ

    キーはテーブル識別ID 、値は１レコード（行）毎にフィールド識別ID と値をマッピングした Map の List 各列のデータ型は列タイプに依存します。
    ※データの更新時は排他チェック用に更新対象データのバージョン番号が必須です。

    登録情報マップにキー:imfr_sd_version_no でバージョン番号を設定してください。
    ※ファイルアップロードアイテムの情報は登録データに含まれません。

  • アイテムのデータ型と値のデータ型

    ../../_images/table_5125.png

スクリプト開発モデル

アプリケーションデータを登録または検索・削除するための下記のオブジェクトが用意されています。

  • FRApplicationDataManager

コンストラクタ

  • コンストラクタ①

    • FRApplicationDataManager(String loginUserCd)

      このコンストラクタを利用してマネージャオブジェクトを生成した場合、データ操作を行った際に後処理の設定があった場合は後処理が実行されます。

    • パラメータ

      loginUserCd ログインユーザCD

  • コンストラクタ②

    • FRApplicationDataManager(String loginUserCd, Boolean execPostProcFlg)

      このコンストラクタを利用してマネージャオブジェクトを生成時にデータ操作を行った際の後処理の実行有無を指定することができます。

    • パラメータ

      loginUserCd ログインユーザCD
      execPostProcFlg 後処理実行フラグ 後処理を実行する場合は true 、しない場合は false

主なメソッド

データの取得メソッド

  • ItemDataObject getItemData (String applicationId, String insertId, Boolean systemData)

    指定されたデータ登録ID の登録情報を返却します。

    • パラメータ

      applicationId アプリケーションID
      insertId 登録データID
      systemData システム情報の取得の有無 取得する場合は true、しない場合は false

    • 返却値

      登録情報オブジェクト
      ※詳細は後述のItemDataObject 登録情報オブジェクトをご参照ください。

データの登録メソッド

  • void insertItemData(String applicationId, Number applicationNo, String insertId, ItemDataObject object)

    アプリケーションの登録情報をテーブルに登録します。

    • パラメータ

      applicationId アプリケーションID
      applicationNo アプリケーションバージョンNO（アプリケーション履歴番号）
      insertId 登録データID
      ItemDataObject 登録情報オブジェクト
      ※詳細は後述のItemDataObject 登録情報オブジェクトをご参照ください。

    • 返却値

      なし

      後処理内でこのメソッドを使用する場合、さらに後処理を実行する必要がない場合はコンストラクタ②の execPostProcFlg を false にしてマネージャオブジェクトを生成してください。

データの更新メソッド

  • void updateItemData(String applicationId, Number applicationNo, String insertId, ItemDataObject object)

    指定された登録データID の登録情報を更新します。

    • パラメータ

      applicationId アプリケーションID
      applicationNo アプリケーションバージョンNO（アプリケーション履歴番号）
      insertId 登録データID
      ItemDataObject 登録情報オブジェクト
      ※詳細は後述の登録情報マップをご参照ください。

    • 返却値

      なし

      後処理内でこのメソッドを使用する場合、さらに後処理を実行する必要がない場合はコンストラクタ②の execPostProcFlg を false にしてマネージャオブジェクトを生成してください。

データの削除メソッド

  • void deleteItemData(String applicationId, String insertId, Number versionNo)

    指定された登録データID の登録情報を削除します。

    • パラメータ

      applicationId アプリケーションID
      insertId 登録データID
      versionNo データバージョン番号

    • 返却値

      なし

      後処理内でこのメソッドを使用する場合、さらに後処理を実行する必要がない場合はコンストラクタ②の execPostProcFlg を false にしてマネージャオブジェクトを生成してください。

ItemDataObject 登録情報オブジェクト

  • 明細テーブル以外のアイテム

    プロパティ：フィールド識別ID

  • 明細テーブルアイテムのデータ

    プロパティ：テーブル識別ID

    値は１レコード（行）毎に各列のフィールド識別ID と値をマッピングしたオブジェクトの配列です。
    各列のデータ型は列タイプに依存します。

    ※データの更新時は排他チェック用に更新対象データのバージョン番号が必須です。
    登録情報オブジェクトの imfr_sd_version_no プロパティにバージョン番号を設定してください。
    ※ファイルアップロードアイテムの情報には登録データには含まれません。

  • アイテムのデータ型と値のデータ型

    ../../_images/table_5225.png

«  前処理   ::   コンテンツ   ::   PDF出力処理  »

Copyright © 2013 NTT DATA INTRAMART CORPORATION