IM-FormaDesigner for Accel Platform プログラミングガイド 第13版 2018-04-01

7. 登録データ情報管理API

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

7.1. JavaEE開発モデル

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

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

7.1.1. コンストラクタ

  • コンストラクタ①

    • ApplicationDataManager(String loginUserCd)

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

      パラメータ  
      loginUserCd ログインユーザコード
  • コンストラクタ②

    • ApplicationDataManager(String loginUserCd, boolean execPostProcFlg)

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

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

7.1.2. 主なメソッド

7.1.2.1. データの取得メソッド

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

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

    • パラメータ

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

      返却値  
      登録情報マップ ※詳細は後述の登録情報マップを参照してください。

7.1.2.2. データの登録メソッド

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

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

    • パラメータ

      パラメータ  
      applicationId アプリケーションID
      applicationNo アプリケーションバージョンNO(アプリケーション履歴番号)
      insertId 登録データID
      itemData
      登録情報マップ
      ※詳細は後述の登録情報マップを参照してください。
    • 返却値

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

コラム

登録データIDはアプリケーションのデータを一意に識別するためのキーです。

7.1.2.3. データの更新メソッド

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

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

    • パラメータ

      パラメータ  
      applicationId アプリケーションID
      applicationNo アプリケーションバージョンNO(アプリケーション履歴番号)
      insertId 登録データID
      itemData
      登録情報マップ
      ※詳細は後述の登録情報マップを参照してください。
    • 返却値

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

7.1.2.4. データの削除メソッド

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

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

    • パラメータ

      パラメータ  
      applicationId アプリケーションID
      insertId 登録データID
      versionNo データバージョン番号
    • 返却値

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

7.1.2.5. 登録情報マップ

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

  • Map<String, Object>

  • 画面アイテム「明細テーブル」、「グリッドテーブル」以外の画面アイテム

    キー :フィールド識別ID
    値: 入力値
  • 画面アイテム「明細テーブル」、「グリッドテーブル」のデータ

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

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

    アイテムのデータ型 値のデータ型
    文字列 java.lang.String
    数値
    <データの登録・更新時>
    java.lang.Numberのサブクラス
    <データ取得時>
    java.math.BigDecimal
    日付 java.sql.Date
    タイムスタンプ java.sql.Timestamp

コラム

API利用時に、メソッドの引数として設定した登録情報マップは、後処理プログラムの引数となるsendParamマップへは連携されません。

7.2. スクリプト開発モデル

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

  • FRApplicationDataManager

7.2.1. コンストラクタ

  • コンストラクタ①

    • FRApplicationDataManager(String loginUserCd)

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

      • パラメータ

        パラメータ  
        loginUserCd ログインユーザコード
  • コンストラクタ②

    • FRApplicationDataManager(String loginUserCd, Boolean execPostProcFlg)

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

      • パラメータ

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

7.2.2. 主なメソッド

7.2.2.1. データの取得メソッド

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

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

    • パラメータ

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

      下記の情報を持つオブジェクトを返します。
      返却値  
      data
      登録情報オブジェクト
      ※詳細は後述のItemDataObject 登録情報オブジェクトを参照してください。
      error
      エラーフラグ
      処理に失敗した場合は true 、成功した場合はfalseを返します。
      errorMessage エラーメッセージ

7.2.2.2. データの登録メソッド

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

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

    • パラメータ

      パラメータ  
      applicationId アプリケーションID
      applicationNo アプリケーションバージョンNO(アプリケーション履歴番号)
      insertId 登録データID
      itemDataObject
      登録情報オブジェクト
      ※詳細は後述のItemDataObject 登録情報オブジェクトを参照してください。
    • 返却値

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

コラム

登録データIDはアプリケーションのデータを一意に識別するためのキーです。
Identifierオブジェクトのgetメソッド を利用して採番してください。

7.2.2.3. データの更新メソッド

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

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

    • パラメータ

      パラメータ  
      applicationId アプリケーションID
      applicationNo アプリケーションバージョンNO(アプリケーション履歴番号)
      insertId 登録データID
      ItemDataObject
      登録情報オブジェクト
      ※詳細は後述のItemDataObject 登録情報オブジェクトを参照してください。
      後処理内でこのメソッドを使用する場合、さらに後処理を実行する必要がない場合はコンストラクタ②の execPostProcFlg を false にしてマネージャオブジェクトを生成してください。

7.2.2.4. データの削除メソッド

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

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

    • パラメータ

      パラメータ  
      applicationId アプリケーションID
      insertId 登録データID
      versionNo データバージョン番号
    • 返却値

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

7.2.2.5. ItemDataObject 登録情報オブジェクト

  • 画面アイテム「明細テーブル」、「グリッドテーブル」以外の画面アイテム

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

  • 画面アイテム「明細テーブル」、「グリッドテーブル」のデータ

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

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

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

    アイテムのデータ型 値のデータ型
    文字列 String
    数値 Number
    日付またはタイムスタンプ Date

コラム

API利用時に、メソッドの引数として設定した登録情報オブジェクトは、後処理プログラムの引数となるsendParamマップへは連携されません。

7.2.2.6. ResultObject 処理結果オブジェクト

  • error:エラーフラグ

    処理に失敗した場合は true 、成功した場合はfalseを返します。

  • exclusionError : 排他エラーフラグ

    更新、削除時に排他エラーが発生した場合はtrue、以外はfalseを返します。

  • errorMessage: エラーメッセージ