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

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

public class FormManager
extends java.lang.Object

フォーム情報管理クラス。
IM-VisualDesignerのフォーム情報操作用のクラスです。

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

コンストラクタの概要
FormManager(java.lang.String loginUserCd, java.lang.String loginGroupId)
          コンストラクタ
 
メソッドの概要
 void deleteForm(java.lang.String formId, boolean removeFile)
          指定されたフォームIDのフォーム情報を削除します。
 void deleteVersion(java.lang.String formId, int formNo, boolean removeFile)
          指定されたフォームのバージョン情報を削除します。
 FormInfoModel deployForm(java.lang.String formName, java.lang.String formNotes, java.lang.String fileName, byte[] deployFile)
          フォームをデプロイします。
 FormVersionModel deployNewVersion(FormVersionModel model, java.lang.String fileName, byte[] deployFile)
          指定されたフォームの新規バージョンを追加します。
 FormVersionModel deployVersion(FormVersionModel model, java.lang.String fileName, byte[] deployFile)
          指定されたフォームのバージョンを再デプロイします。
 DataDefineInfoModel getDataDefinitionInfo(java.lang.String formId, int formNo)
          登録データ定義情報を返却します。
 DocumentDefModel getDefinitionInfo(java.lang.String formId, int formNo)
          フォームの定義情報を返却します。
 java.lang.String getDeployPath(java.lang.String formId, int formNo)
          フォームファイル(デプロイファイル)の配置されるパスを返却します。
 FormInfoModel getFormInfo(java.lang.String formId)
          指定されたフォームIDのフォーム情報を返却します。
 int getFormInfoCount(FormInfoKey key)
          検索条件に一致するフォーム情報の件数を返却します。
 FormInfoModel[] getFormInfoList(FormInfoKey key)
          検索条件に一致するフォーム情報を配列で返却します。
 FormInfoModel[] getFormInfoList(FormInfoKey key, int acquisitionCount, int startRecord)
          検索条件に一致するフォーム情報配列を返却します。
 FormVersionModel getFormVersion(java.lang.String formId, int formNo)
          指定されたフォームのフォーム履歴情報を返却します。
 int getFormVersionCount(FormVersionKey key)
          検索条件に一致するフォーム履歴情報の件数を返却します。
 FormVersionModel[] getFormVersionList(FormVersionKey key)
          検索条件に一致したフォーム履歴情報の配列を返却します。
 FormVersionModel[] getFormVersionList(FormVersionKey key, int acquisitionCount, int startRecord)
          検索条件に一致したフォーム履歴情報の配列を返却します。
 NetworkFile getSchemaFile(java.lang.String formId, int formNo)
          フォームのXMLスキーマファイルを返却します。
 FormInfoModel updateFormInfo(FormInfoModel model)
          フォーム情報を更新します。
 FormVersionModel updateVersionInfo(FormVersionModel model)
          フォーム履歴情報を更新します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

FormManager

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

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

deployForm

public FormInfoModel deployForm(java.lang.String formName,
                                java.lang.String formNotes,
                                java.lang.String fileName,
                                byte[] deployFile)
                         throws SystemException,
                                ApplicationException
フォームをデプロイします。
デプロイされたフォームのフォームIDには、デプロイファイル名(拡張子なし)が設定されます。
デプロイファイルには、クライアントツールでエクスポートしたZIPファイルを指定してください。

パラメータ:
formName - フォーム名
formNotes - 備考
fileName - デプロイファイル名
deployFile - デプロイファイル
戻り値:
登録したフォーム情報オブジェクト
例外:
SystemException - データベース接続エラー等のシステム例外が発生した場合にスローされます。
ApplicationException - フォームIDが重複している等のアプリケーションエラーが発生した場合にスローされます。

deployVersion

public FormVersionModel deployVersion(FormVersionModel model,
                                      java.lang.String fileName,
                                      byte[] deployFile)
                               throws ApplicationException,
                                      SystemException
指定されたフォームのバージョンを再デプロイします。
このメソッドでは、指定されたフォーム履歴番号のフォームを再デプロイします。
Storageサービスに配置されていたファイルは一度全て削除され、指定されたデプロイファイルの内容を再配置します。
デプロイファイル名(拡張子なし)とフォームIDが一致しない場合はエラーとなります。

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

deployNewVersion

public FormVersionModel deployNewVersion(FormVersionModel model,
                                         java.lang.String fileName,
                                         byte[] deployFile)
                                  throws ApplicationException,
                                         SystemException
指定されたフォームの新規バージョンを追加します。
デプロイファイル名(拡張子なし)とフォームIDが一致しない場合はエラーとなります。

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

deleteForm

public void deleteForm(java.lang.String formId,
                       boolean removeFile)
                throws ApplicationException,
                       SystemException
指定されたフォームIDのフォーム情報を削除します。
複数のバージョン情報が存在する場合は、フォームの削除は行えません。
バージョン情報が複数存在する場合は、deleteVersion(String, int, boolean)を利用してバージョン情報を削除してください。

パラメータ:
formId - フォームID
removeFile - フォームファイル(デプロイファイル)を削除するかどうか
例外:
ApplicationException - フォーム情報が存在しない等、アプリケーションエラーが発生した場合にスローされます。
SystemException - データベース接続エラー等、システム例外が発生した場合にスローされます。

deleteVersion

public void deleteVersion(java.lang.String formId,
                          int formNo,
                          boolean removeFile)
                   throws ApplicationException,
                          SystemException
指定されたフォームのバージョン情報を削除します。
バージョン情報が1つしか存在しない場合は、バージョンの削除は行えません。
1つしかバージョンの存在しないフォームを削除する場合は、deleteForm(String, boolean)を使用してください。

パラメータ:
formId - フォームID
formNo - フォーム履歴番号
removeFile - フォームファイル(デプロイファイル)を削除するかどうか
例外:
ApplicationException - フォーム情報が存在しない等、アプリケーションエラーが発生した場合にスローされます。
SystemException - データベース接続エラー等、システム例外が発生した場合にスローされます。

updateFormInfo

public FormInfoModel updateFormInfo(FormInfoModel model)
                             throws ApplicationException,
                                    SystemException
フォーム情報を更新します。
このメソッドはフォームのデプロイを行わず、フォーム名等の基本情報のみ更新する場合に使用します。

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

updateVersionInfo

public FormVersionModel updateVersionInfo(FormVersionModel model)
                                   throws ApplicationException,
                                          SystemException
フォーム履歴情報を更新します。
このメソッドはフォームのデプロイを行わず、備考等のフォーム履歴情報を更新します。

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

getFormInfoCount

public int getFormInfoCount(FormInfoKey key)
                     throws SystemException
検索条件に一致するフォーム情報の件数を返却します。

パラメータ:
key - フォーム情報検索キー
戻り値:
フォーム情報の件数
例外:
SystemException - データベース接続エラー等の、システム例外が発生した場合にスローされます。

getFormInfo

public FormInfoModel getFormInfo(java.lang.String formId)
                          throws SystemException
指定されたフォームIDのフォーム情報を返却します。
フォーム情報が存在しない場合はnullが返却されます。

パラメータ:
formId - フォームID
戻り値:
フォーム情報
例外:
SystemException - データベース接続エラー等の、システム例外が発生した場合にスローされます。

getFormInfoList

public FormInfoModel[] getFormInfoList(FormInfoKey key)
                                throws SystemException
検索条件に一致するフォーム情報を配列で返却します。
このメソッドを使用した場合、該当したデータを1件目から全件返却します。

パラメータ:
key - フォーム情報検索キー
戻り値:
フォーム情報配列
例外:
SystemException - データベース接続エラー等の、システム例外が発生した場合にスローされます。

getFormInfoList

public FormInfoModel[] getFormInfoList(FormInfoKey key,
                                       int acquisitionCount,
                                       int startRecord)
                                throws SystemException
検索条件に一致するフォーム情報配列を返却します。

パラメータ:
key - フォーム情報検索キー
acquisitionCount - 取得件数
0を指定すると全件取得になります。
startRecord - 取得開始位置
0を指定すると1件目から取得します。
戻り値:
フォーム情報配列
例外:
SystemException - データベース接続エラー等の、システム例外が発生した場合にスローされます。

getFormVersionCount

public int getFormVersionCount(FormVersionKey key)
                        throws SystemException
検索条件に一致するフォーム履歴情報の件数を返却します。

パラメータ:
key - フォーム履歴情報検索キー
戻り値:
フォーム履歴情報の件数
例外:
SystemException - データベース接続エラー等の、システム例外が発生した場合にスローされます。

getFormVersion

public FormVersionModel getFormVersion(java.lang.String formId,
                                       int formNo)
                                throws SystemException
指定されたフォームのフォーム履歴情報を返却します。
指定されたフォームの履歴情報が存在しない場合はnullを返却します。

パラメータ:
formId - フォームID
formNo - フォーム履歴番号
戻り値:
フォーム履歴情報
例外:
SystemException - データベース接続エラー等の、システム例外が発生した場合にスローされます。

getFormVersionList

public FormVersionModel[] getFormVersionList(FormVersionKey key)
                                      throws SystemException
検索条件に一致したフォーム履歴情報の配列を返却します。
このメソッドを使用した場合、該当したデータを1件目から全件返却します。

パラメータ:
key - フォーム履歴検索キー
戻り値:
フォーム履歴情報配列
例外:
SystemException - データベース接続エラー等の、システム例外が発生した場合にスローされます。

getFormVersionList

public FormVersionModel[] getFormVersionList(FormVersionKey key,
                                             int acquisitionCount,
                                             int startRecord)
                                      throws SystemException
検索条件に一致したフォーム履歴情報の配列を返却します。

パラメータ:
key - フォーム履歴検索キー
acquisitionCount - 取得件数
0を指定すると全件取得になります。
startRecord - 取得開始位置
0を指定すると1件目から取得します。
戻り値:
フォーム履歴情報配列
例外:
SystemException - データベース接続エラー等の、システム例外が発生した場合にスローされます。

getDeployPath

public java.lang.String getDeployPath(java.lang.String formId,
                                      int formNo)
フォームファイル(デプロイファイル)の配置されるパスを返却します。
デプロイ時にファイルを配置するStorage Serviceのパスを返却します。

パラメータ:
formId - フォームID
formNo - フォーム履歴番号
戻り値:
ファイルの配置先パス

getDefinitionInfo

public DocumentDefModel getDefinitionInfo(java.lang.String formId,
                                          int formNo)
                                   throws SystemException
フォームの定義情報を返却します。
指定されたフォームの定義情報(設定されている項目情報)を返却します。

パラメータ:
formId - フォームID
formNo - フォーム履歴番号
戻り値:
フォーム定義情報
例外:
SystemException - ファイルの読み込みに失敗した場合等、システムエラーが発生した場合にスローされます。

getDataDefinitionInfo

public DataDefineInfoModel getDataDefinitionInfo(java.lang.String formId,
                                                 int formNo)
                                          throws ApplicationException,
                                                 SystemException
登録データ定義情報を返却します。
指定されたフォームの定義情報から登録データに関する設定情報を返却します。

パラメータ:
formId - フォームID
formNo - フォーム履歴情報
戻り値:
登録データ定義情報オブジェクト
例外:
SystemException - ファイルの読み込みに失敗した場合等、システムエラーが発生した場合にスローされます。
ApplicationException

getSchemaFile

public NetworkFile getSchemaFile(java.lang.String formId,
                                 int formNo)
                          throws SystemException,
                                 ApplicationException
フォームのXMLスキーマファイルを返却します。

パラメータ:
formId - フォームID
formNo - フォーム履歴番号
戻り値:
XMLスキーマ
例外:
SystemException - ファイルの読み込みに失敗した場合等、システムエラーが発生した場合にスローされます。
ApplicationException - フォームが存在しない場合など、アプリケーションエラーが発生した場合にスローされます。