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

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

public class FormRelationManager
extends java.lang.Object

フォームリレーション管理クラス。
ドキュメントに紐付けられたフォーム情報操作用のクラスです。

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

コンストラクタの概要
FormRelationManager(java.lang.String loginUserCd, java.lang.String loginGroupId)
          コンストラクタ
 
メソッドの概要
 void deleteRelation(FormRelationModel model)
          ドキュメントに紐づいたフォーム情報を削除します。
 FormRelationModel getRelation(java.lang.String documentId, int documentNo, FormUsageType usageType, java.lang.String formId)
          指定された使用用途のフォーム連携情報を返却します。
 FormRelationModel[] getRelations(FormRelationKey key, int acquisitionCount, int startRecord)
          検索条件に一致するフォーム連携情報を配列で返却します。
 void insertRelation(FormRelationModel model)
          ドキュメントに紐付けるフォーム情報を登録します。
 void updateRelation(FormRelationModel model)
          ドキュメントに紐付けられているフォーム情報を更新します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

FormRelationManager

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

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

insertRelation

public void insertRelation(FormRelationModel model)
                    throws ApplicationException,
                           SystemException
ドキュメントに紐付けるフォーム情報を登録します。

パラメータ:
model - フォーム連携情報オブジェクト
例外:
ApplicationException - ドキュメントやフォームが存在しない場合、もしくは既に連携済みのフォームを登録しようとした場合にスローされます。
SystemException - データベース接続に失敗した場合等、システム例外が発生した場合にスローされます。

updateRelation

public void updateRelation(FormRelationModel model)
                    throws ApplicationException,
                           SystemException
ドキュメントに紐付けられているフォーム情報を更新します。

パラメータ:
model - フォーム連携情報オブジェクト
例外:
ApplicationException - ドキュメントやフォームが存在しない場合等にスローされます。
SystemException - データベース接続に失敗した場合等、システム例外が発生した場合にスローされます。

deleteRelation

public void deleteRelation(FormRelationModel model)
                    throws ApplicationException,
                           SystemException
ドキュメントに紐づいたフォーム情報を削除します。

パラメータ:
model - リレーション情報
削除時には、以下のパラメータを設定して下さい。
  • ドキュメントID (必須)
  • ドキュメントNO (任意 : 指定なしの場合は全ての履歴のリレーションを削除します。)
  • ページ種別 (任意 : 指定なしの場合は全てのページ種別のリレーションを削除します。)
  • フォームID (任意 : ページ種別「その他」の場合に指定します。)
例外:
ApplicationException - ドキュメントやフォームが存在しない場合等にスローされます。
SystemException - データベース接続に失敗した場合等、システム例外が発生した場合にスローされます。

getRelations

public FormRelationModel[] getRelations(FormRelationKey key,
                                        int acquisitionCount,
                                        int startRecord)
                                 throws SystemException
検索条件に一致するフォーム連携情報を配列で返却します。

パラメータ:
key - 検索条件オブジェクト
acquisitionCount - 取得件数
startRecord - 取得開始位置
戻り値:
フォーム連携情報配列
例外:
SystemException - データベース接続に失敗した場合等、システム例外が発生した場合にスローされます。

getRelation

public FormRelationModel getRelation(java.lang.String documentId,
                                     int documentNo,
                                     FormUsageType usageType,
                                     java.lang.String formId)
                              throws SystemException
指定された使用用途のフォーム連携情報を返却します。
引数「フォームID」はフォーム使用用途に「MIDDLE(中間画面)」を指定した場合に設定してください。

パラメータ:
documentId - ドキュメントID
documentNo - ドキュメント履歴番号
usageType - フォーム使用用途
formId - フォ−ムID
戻り値:
フォーム連携情報オブジェクト
例外:
SystemException - データベース接続に失敗した場合等、システム例外が発生した場合にスローされます。