jp.co.intra_mart.foundation.straform
クラス DocumentDataManager

java.lang.Object
  上位を拡張 jp.co.intra_mart.foundation.straform.DocumentDataManager

public class DocumentDataManager
extends java.lang.Object

登録データ情報管理クラス。
IM-VisualDesignerのドキュメントを使用して登録されたデータの操作用のクラスです。
このクラスはドキュメントのテーブル設定で設定された各テーブルに対して、データの登録・削除および取得する際に利用します。

 登録情報オブジェクトはキーに「アイテム名」、値に「入力データ」を持つMapオブジェクトになります。
 
 値の「入力データ」はクライアントツールで設定した各アイテムのプロパティ「データ型」の設定によって型が異なります。
    データ型が「文字型」の場合 : String
    データ型が「数値型」の場合 : Number
    データ型が「日付型」の場合 : Date
 
 また、「テーブル行を追加」アクションの対象となっているテーブルがある場合、
 行追加の対象行に配置されたアイテムの情報は複数件存在する為、配列で設定する必要があります。
 
 登録情報Mapオブジェクト
 └「テーブルの名前」 : 「テーブル行を追加」アクションの対象の行に配置されたアイテム情報配列(List)
                           └対象の行に配置されたアイテム情報オブジェクト(Map)
                                └「アイテム名」(String) : 「入力データ」(Object)
 

導入されたバージョン:
7.2
作成者:
INTRAMART

コンストラクタの概要
DocumentDataManager(java.lang.String loginUserCd, java.lang.String loginGroupId)
          コンストラクタ
 
メソッドの概要
 void deleteItemData(java.lang.String documentId, java.lang.String insertId)
          指定された登録データIDの登録情報を削除します。
 java.lang.String getAttachFilePath(java.lang.String documentId, java.lang.String insertId)
          指定された登録情報の添付ファイルの保存先のパスを返却します。
 java.lang.String getAttachTempPath(java.lang.String documentId)
          添付ファイルの一時保存先のパスを返却します。
 java.util.Map<java.lang.String,java.lang.Object> getItemData(java.lang.String documentId, java.lang.String insertId, boolean systemData)
          指定されたデータ登録IDの登録情報を返却します。
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getItemDataList(java.lang.String documentId, int documentNo, int startRecord, int acquisitionCount)
          指定されたドキュメントの登録情報配列を返却します。
 java.util.Map<java.lang.String,java.lang.Object> getPreserveData(java.lang.String documentId, boolean systemData)
          指定されたドキュメントの一時保存情報を返却します。
 void insertItemData(java.lang.String documentId, int documentNo, java.lang.String insertId, java.util.Map<java.lang.String,java.lang.Object> itemData)
          ドキュメントの登録情報をテーブルに登録します。
 void insertPreserveData(java.lang.String documentId, int documentNo, java.lang.String insertId, java.util.Map<java.lang.String,java.lang.Object> itemData)
          一時保存データを登録します。
 void updateItemData(java.lang.String documentId, int documentNo, java.lang.String insertId, java.util.Map<java.lang.String,java.lang.Object> itemData)
          登録情報を更新します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

DocumentDataManager

public DocumentDataManager(java.lang.String loginUserCd,
                           java.lang.String loginGroupId)
コンストラクタ

パラメータ:
loginUserCd - ログインユーザCD
loginGroupId - ログイングループID
メソッドの詳細

insertItemData

public void insertItemData(java.lang.String documentId,
                           int documentNo,
                           java.lang.String insertId,
                           java.util.Map<java.lang.String,java.lang.Object> itemData)
                    throws SystemException,
                           ApplicationException
ドキュメントの登録情報をテーブルに登録します。
テーブル設定で設定されたテーブルへドキュメントの入力情報を登録します。
指定された登録情報オブジェクトに値が設定されていない項目にはnullが登録されます。

パラメータ:
documentId - ドキュメントID
documentNo - ドキュメント履歴番号
insertId - 登録データID
itemData - 登録情報オブジェクト
例外:
SystemException - データベース接続に失敗した場合等のシステムエラーが発生した場合にスローされます。
ApplicationException - テーブル設定が設定されていない場合等のアプリケーションエラーが発生した場合にスローされます。

updateItemData

public void updateItemData(java.lang.String documentId,
                           int documentNo,
                           java.lang.String insertId,
                           java.util.Map<java.lang.String,java.lang.Object> itemData)
                    throws SystemException,
                           ApplicationException
登録情報を更新します。
指定された登録データIDの登録情報を更新します。
指定された登録情報オブジェクトに値が設定されていない項目は更新されません。

パラメータ:
documentId - ドキュメントID
documentNo - ドキュメント履歴番号
insertId - 登録データID
itemData - 登録情報オブジェクト
例外:
SystemException - データベース接続に失敗した場合等のシステムエラーが発生した場合にスローされます。
ApplicationException - テーブル設定が設定されていない場合等のアプリケーションエラーが発生した場合にスローされます。

deleteItemData

public void deleteItemData(java.lang.String documentId,
                           java.lang.String insertId)
                    throws SystemException,
                           ApplicationException
指定された登録データIDの登録情報を削除します。

パラメータ:
documentId - ドキュメントID
insertId - 登録データID
例外:
SystemException - データベース接続に失敗した場合等のシステムエラーが発生した場合にスローされます。
ApplicationException - テーブル設定が設定されていない場合等のアプリケーションエラーが発生した場合にスローされます。

getItemData

public java.util.Map<java.lang.String,java.lang.Object> getItemData(java.lang.String documentId,
                                                                    java.lang.String insertId,
                                                                    boolean systemData)
                                                             throws SystemException,
                                                                    ApplicationException
指定されたデータ登録IDの登録情報を返却します。

パラメータ:
documentId - ドキュメントID
insertId - データ登録ID
systemData - システム情報を取得するかどうか
戻り値:
登録情報Mapオブジェクト
例外:
SystemException - システム例外が発生
ApplicationException - アプリケーション例外が発生

getItemDataList

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getItemDataList(java.lang.String documentId,
                                                                                        int documentNo,
                                                                                        int startRecord,
                                                                                        int acquisitionCount)
                                                                                 throws SystemException,
                                                                                        ApplicationException
指定されたドキュメントの登録情報配列を返却します。
登録情報に含まれる項目は指定されたドキュメント履歴番号に設定された登録フォームの設定項目になります。

パラメータ:
documentId - ドキュメントID
documentNo - ドキュメント履歴番号
startRecord - 取得開始位置
0を指定すると先頭行からの取得になります。
acquisitionCount - 取得件数
0を指定すると無制限となります。
データ件数が多い場合にOutOfMemoryExceptionが発生する可能性がありますのでご注意ください。
戻り値:
登録情報Mapオブジェクト配列
例外:
SystemException - データベース接続に失敗した場合等のシステムエラーが発生した場合にスローされます。
ApplicationException - テーブル設定が設定されていない場合等のアプリケーションエラーが発生した場合にスローされます。

insertPreserveData

public void insertPreserveData(java.lang.String documentId,
                               int documentNo,
                               java.lang.String insertId,
                               java.util.Map<java.lang.String,java.lang.Object> itemData)
                        throws SystemException,
                               ApplicationException
一時保存データを登録します。
指定された登録情報オブジェクトに値が設定されていない項目にはnullが登録されます。

パラメータ:
documentId - ドキュメントID
documentNo - ドキュメント履歴番号
insertId - 登録データID
itemData - 登録情報オブジェクト
例外:
SystemException - データベース接続に失敗した場合等のシステムエラーが発生した場合にスローされます。
ApplicationException - テーブル設定が設定されていない場合等のアプリケーションエラーが発生した場合にスローされます。

getPreserveData

public java.util.Map<java.lang.String,java.lang.Object> getPreserveData(java.lang.String documentId,
                                                                        boolean systemData)
                                                                 throws SystemException,
                                                                        ApplicationException
指定されたドキュメントの一時保存情報を返却します。

パラメータ:
documentId - ドキュメントID
戻り値:
一時保存情報Mapオブジェクト
例外:
SystemException - データベース接続に失敗した場合等のシステムエラーが発生した場合にスローされます。
ApplicationException - テーブル設定が設定されていない場合等のアプリケーションエラーが発生した場合にスローされます。

getAttachFilePath

public java.lang.String getAttachFilePath(java.lang.String documentId,
                                          java.lang.String insertId)
指定された登録情報の添付ファイルの保存先のパスを返却します。

パラメータ:
documentId - ドキュメントID
insertId - 登録データID
戻り値:
添付ファイルの保存先パス

getAttachTempPath

public java.lang.String getAttachTempPath(java.lang.String documentId)
添付ファイルの一時保存先のパスを返却します。
登録画面よりデータを登録際に添付ファイルを一時保存する保存先のパスを返却します。

パラメータ:
documentId - ドキュメントID
戻り値:
添付ファイルの一時保存先パス