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

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

public class DocumentManager
extends java.lang.Object

ドキュメント情報管理クラス。
IM-VisualDesignerのドキュメント情報操作用のクラスです。

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

コンストラクタの概要
DocumentManager(java.lang.String loginUserCd, java.lang.String loginGroupId)
          コンストラクタ
 
メソッドの概要
 DocumentVersionModel addVersion(DocumentVersionModel model)
          ドキュメントの履歴情報を追加します。
 DocumentInfoModel createDocument(DocumentInfoModel model)
          ドキュメントの新規登録を行ないます。
 void deleteDocument(java.lang.String documentId)
          ドキュメント情報の削除を行ないます。
 void deleteTableSetting(java.lang.String documentId, java.lang.String objectId)
          テーブル設定情報を削除します。
 void deleteVersion(java.lang.String documentId, int documentNo)
          ドキュメント履歴情報を削除します。
 DocumentInfoModel getDocumentInfo(java.lang.String documentId)
          指定されたドキュメントIDのドキュメント情報を取得します。
 int getDocumentInfoCount(DocumentInfoKey key)
          検索条件に一致するドキュメント情報の件数を取得します。
 DocumentInfoModel[] getDocumentInfoList(DocumentInfoKey key)
          検索条件に一致するドキュメント情報配列を取得します。
 DocumentInfoModel[] getDocumentInfoList(DocumentInfoKey key, int acquisitionCount, int startRecord)
          検索条件に一致するドキュメント情報配列を取得します。
 DocumentVersionModel getDocumentVersion(java.lang.String documentId, int documentNo)
          指定されたドキュメント番号(履歴番号)のドキュメント履歴情報を取得します。
 int getDocumentVersionCount(DocumentVersionKey key)
          検索条件に一致するドキュメント履歴情報の件数を取得します。
 DocumentVersionModel[] getDocumentVersionList(DocumentVersionKey key)
          検索条件に一致するドキュメント履歴情報配列を取得します。
 DocumentVersionModel[] getDocumentVersionList(DocumentVersionKey key, int acquisitionCount, int startRecord)
          検索条件に一致するドキュメント履歴情報配列を取得します。
 TableSettingInfoModel[] getTableSetting(java.lang.String documentId)
          テーブル設定情報を取得します。
 TableSettingInfoModel getTableSetting(java.lang.String documentId, java.lang.String objectId)
          テーブル設定情報を取得します。
 void insertTableSetting(TableSettingInfoModel model)
          テーブル設定情報を登録します。
 DocumentInfoModel updateDocument(DocumentInfoModel model)
          ドキュメント情報を更新します。
 DocumentVersionModel updateVersion(DocumentVersionModel model)
          ドキュメント履歴情報を更新します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

DocumentManager

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

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

createDocument

public DocumentInfoModel createDocument(DocumentInfoModel model)
                                 throws ApplicationException,
                                        SystemException
ドキュメントの新規登録を行ないます。
このメソッドでは、ドキュメント情報のみ登録されます。(ドキュメント履歴情報は登録されません。)
ドキュメント履歴情報を登録するには、addVersionメソッドを利用してください。

パラメータ:
model - ドキュメント情報
戻り値:
登録したドキュメント情報
例外:
ApplicationException - ドキュメントIDが重複している等のアプリケーションエラーが発生した場合にスローされます。
SystemException - データベース接続エラー等のシステム例外が発生した場合にスローされます。

addVersion

public DocumentVersionModel addVersion(DocumentVersionModel model)
                                throws ApplicationException,
                                       SystemException
ドキュメントの履歴情報を追加します。
追加する履歴情報のドキュメント番号(履歴番号)は自動的に設定されます。
追加する履歴情報のドキュメント番号(履歴番号)は「最新ドキュメント番号 + 1」となります。

パラメータ:
model - ドキュメント履歴情報
戻り値:
追加したドキュメント履歴情報
例外:
ApplicationException - ドキュメントが存在しない等のアプリケーションエラーが発生した場合にスローされます。
SystemException - データベース接続エラー等のシステム例外が発生した場合にスローされます。

updateDocument

public DocumentInfoModel updateDocument(DocumentInfoModel model)
                                 throws ApplicationException,
                                        SystemException
ドキュメント情報を更新します。
ドキュメント名や備考を変更する場合に利用します。
登録フォームIDは更新できません。

パラメータ:
model - ドキュメント情報
戻り値:
更新したドキュメント情報
例外:
ApplicationException - ドキュメントが存在しない等のアプリケーションエラーが発生した場合にスローされます。
SystemException - データベース接続エラー等のシステム例外が発生した場合にスローされます。

updateVersion

public DocumentVersionModel updateVersion(DocumentVersionModel model)
                                   throws ApplicationException,
                                          SystemException
ドキュメント履歴情報を更新します。
有効期間や備考を変更する場合に利用します。

パラメータ:
model - ドキュメント履歴情報
戻り値:
更新したドキュメント履歴情報
例外:
ApplicationException - 履歴情報が存在しない等のアプリケーションエラーが発生した場合にスローされます。
SystemException - データベース接続エラー等のシステム例外が発生した場合にスローされます。

deleteDocument

public void deleteDocument(java.lang.String documentId)
                    throws ApplicationException,
                           SystemException
ドキュメント情報の削除を行ないます。
指定されたドキュメントIDのドキュメント情報および関連する履歴情報や連携情報を 全て削除します。

このメソッドではドキュメントの履歴が複数ある場合は、エラーとなります。
ドキュメントの履歴を削除する場合は、deleteVersionメソッドを利用してください。

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

deleteVersion

public void deleteVersion(java.lang.String documentId,
                          int documentNo)
                   throws ApplicationException,
                          SystemException
ドキュメント履歴情報を削除します。
このメソッドを利用した場合、履歴情報は論理削除されます。
実データは、ドキュメントの削除を行った際にデータベースから削除されます。

このメソッドでは、履歴情報が1件しかない場合は、エラーとなります。
ドキュメントの削除をする場合は、deleteDocumentを使用してください。

パラメータ:
documentId - ドキュメントID
documentNo - ドキュメント番号
例外:
ApplicationException - 履歴情報が存在しない等のアプリケーションエラーが発生した場合にスローされます。
SystemException - データベース接続エラー等のシステム例外が発生した場合にスローされます。

getDocumentInfoCount

public int getDocumentInfoCount(DocumentInfoKey key)
                         throws SystemException
検索条件に一致するドキュメント情報の件数を取得します。

パラメータ:
key - ドキュメント情報検索キー
戻り値:
ドキュメント情報の件数
例外:
SystemException - システム例外が発生した場合にスローされます。

getDocumentInfo

public DocumentInfoModel getDocumentInfo(java.lang.String documentId)
                                  throws SystemException
指定されたドキュメントIDのドキュメント情報を取得します。

パラメータ:
documentId - ドキュメントID
戻り値:
ドキュメント情報
例外:
SystemException - システム例外が発生した場合にスローされます。

getDocumentInfoList

public DocumentInfoModel[] getDocumentInfoList(DocumentInfoKey key)
                                        throws SystemException
検索条件に一致するドキュメント情報配列を取得します。
このメソッドを使用すると、検索条件に一致したドキュメント情報を全件取得します。

パラメータ:
key - ドキュメント情報検索キー
戻り値:
ドキュメント情報の件数
例外:
SystemException - システム例外が発生した場合にスローされます。

getDocumentInfoList

public DocumentInfoModel[] getDocumentInfoList(DocumentInfoKey key,
                                               int acquisitionCount,
                                               int startRecord)
                                        throws SystemException
検索条件に一致するドキュメント情報配列を取得します。
このメソッドは、取得件数を指定した場合に利用します。

パラメータ:
key - ドキュメント情報検索キー
acquisitionCount - 取得件数
0を指定すると無制限となります。
startRecord - 取得開始位置
0を指定すると先頭行からの取得になります。
戻り値:
ドキュメント情報配列
例外:
SystemException - システム例外が発生した場合にスローされます。

getDocumentVersionCount

public int getDocumentVersionCount(DocumentVersionKey key)
                            throws SystemException
検索条件に一致するドキュメント履歴情報の件数を取得します。

パラメータ:
key - ドキュメント履歴情報検索キー
戻り値:
ドキュメント履歴情報の件数
例外:
SystemException - システム例外が発生した場合にスローされます。

getDocumentVersion

public DocumentVersionModel getDocumentVersion(java.lang.String documentId,
                                               int documentNo)
                                        throws SystemException
指定されたドキュメント番号(履歴番号)のドキュメント履歴情報を取得します。

パラメータ:
documentId - ドキュメントID
documentNo - ドキュメント番号
戻り値:
ドキュメント履歴情報
例外:
SystemException - システム例外が発生した場合にスローされます。

getDocumentVersionList

public DocumentVersionModel[] getDocumentVersionList(DocumentVersionKey key)
                                              throws SystemException
検索条件に一致するドキュメント履歴情報配列を取得します。 このメソッドを使用すると、検索条件に一致したドキュメント履歴情報を全件取得します。

パラメータ:
key - ドキュメント履歴情報検索キー
acquisitionCount - 取得件数
0を指定すると無制限となります。
startRecord - 取得開始位置
0を指定すると先頭行からの取得になります。
戻り値:
ドキュメント履歴情報配列
例外:
SystemException - システム例外が発生した場合にスローされます。

getDocumentVersionList

public DocumentVersionModel[] getDocumentVersionList(DocumentVersionKey key,
                                                     int acquisitionCount,
                                                     int startRecord)
                                              throws SystemException
検索条件に一致するドキュメント履歴情報配列を取得します。 このメソッドは、取得件数を指定した場合に利用します。

パラメータ:
key - ドキュメント履歴情報検索キー
acquisitionCount - 取得件数
0を指定すると無制限となります。
startRecord - 取得開始位置
0を指定すると先頭行からの取得になります。
戻り値:
ドキュメント履歴情報配列
例外:
SystemException - システム例外が発生した場合にスローされます。

insertTableSetting

public void insertTableSetting(TableSettingInfoModel model)
                        throws ApplicationException,
                               SystemException
テーブル設定情報を登録します。

パラメータ:
model - テーブル設定情報
例外:
ApplicationException - ドキュメント情報が存在しない等のアプリケーションエラーが発生した場合にスローされます。
SystemException - システム例外が発生した場合にスローされます。

deleteTableSetting

public void deleteTableSetting(java.lang.String documentId,
                               java.lang.String objectId)
                        throws SystemException
テーブル設定情報を削除します。

パラメータ:
documentId - ドキュメントID
objectId - オブジェクトID
例外:
SystemException - システム例外が発生した場合にスローされます。

getTableSetting

public TableSettingInfoModel[] getTableSetting(java.lang.String documentId)
                                        throws SystemException
テーブル設定情報を取得します。
指定されたドキュメントIDのドキュメントのテーブル設定情報を全て取得します。

パラメータ:
documentId - ドキュメントID
戻り値:
テーブル設定情報配列
例外:
SystemException - システム例外が発生した場合にスローされます。

getTableSetting

public TableSettingInfoModel getTableSetting(java.lang.String documentId,
                                             java.lang.String objectId)
                                      throws SystemException
テーブル設定情報を取得します。
指定されたオブジェクトIDのテーブル設定情報を取得します。

パラメータ:
documentId - ドキュメントID
objectId - オブジェクトID
戻り値:
テーブル設定情報
例外:
SystemException - システム例外が発生した場合にスローされます。