SFFormManager オブジェクト

フォーム情報管理オブジェクト。
IM-VisualDesignerのフォーム情報操作用のオブジェクトです。
導入されたバージョン:7.2

コンストラクタの概要
SFFormManager (String loginUserId ,String loginGroupId)
コンストラクタ

メソッドの概要
SFResultInfo deleteForm (String formId ,Boolean removeFile)
指定されたフォームIDのフォーム情報を削除します。
SFResultInfo deleteVersion (String formId ,Number formNo ,Boolean removeFile)
指定されたフォームのバージョン情報を削除します。
String getDeployPath (String formId ,Number formNo)
フォームファイル(デプロイファイル)の配置されるパスを返却します。
SFResultInfo getFormInfo (String formId)
指定されたフォームIDのフォーム情報を返却します。
SFResultInfo getFormInfoCount (SFFormKey condition)
検索条件に一致するフォーム情報の件数を取得します。
SFResultInfo getFormInfoList (SFFormKey condition ,Number startRow ,Number length)
検索条件に一致するフォーム情報配列を取得します。
SFResultInfo getFormVersion (String formId ,Number formNo)
指定されたフォーム履歴番号のフォーム履歴情報を取得します。
SFResultInfo getFormVersionCount (SFFormVersionKey condition)
検索条件に一致するフォーム履歴情報の件数を取得します。
SFResultInfo getFormVersionList (SFFormVersionKey condition ,Number startRow ,Number length)
検索条件に一致するフォーム履歴情報配列を取得します。
SFResultInfo updateFormInfo (SFFormInfo arg)
フォーム情報を更新します。
SFResultInfo updateVersionInfo (SFFormVersionInfo arg)
フォーム履歴情報を更新します。

コンストラクタの詳細
SFFormManager

SFFormManager (String loginUserId ,String loginGroupId)
コンストラクタ
パラメータ
loginUserId String ログインユーザID
loginGroupId String ログイングループID

メソッドの詳細
deleteForm

SFResultInfo deleteForm (String formId ,Boolean removeFile)

指定されたフォームIDのフォーム情報を削除します。
複数のバージョン情報が存在する場合は、フォームの削除は行えません。
バージョン情報が複数存在する場合は、deleteVesion関数を利用してバージョン情報を削除してください。
パラメータ
formId String フォームID
removeFile Boolean デプロイしたファイルを削除するかどうか
返却値
SFResultInfo 処理結果オブジェクト

deleteVersion

SFResultInfo deleteVersion (String formId ,Number formNo ,Boolean removeFile)

指定されたフォームのバージョン情報を削除します。
バージョン情報が1つしか存在しない場合は、バージョンの削除は行えません。
1つしかバージョンの存在しないフォームを削除する場合は、deleteForm関数を使用してください。
パラメータ
formId String フォームID
formNo Number フォーム履歴番号
removeFile Boolean デプロイしたファイルを削除するかどうか
返却値
SFResultInfo 処理結果オブジェクト

getDeployPath

String getDeployPath (String formId ,Number formNo)

フォームファイル(デプロイファイル)の配置されるパスを返却します。
デプロイ時にファイルを配置するStorage Serviceのパスを返却します。
パラメータ
formId String フォームID
formNo Number フォーム履歴番号
返却値
String ファイルの配置先パス

getFormInfo

SFResultInfo getFormInfo (String formId)

指定されたフォームIDのフォーム情報を返却します。
フォーム情報が存在しない場合はnullが返却されます。
パラメータ
formId String フォームID
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data フォーム情報オブジェクト
 

getFormInfoCount

SFResultInfo getFormInfoCount (SFFormKey condition)

検索条件に一致するフォーム情報の件数を取得します。
パラメータ
condition SFFormKey フォーム情報検索オブジェクト
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data Number 該当データ件数
 

getFormInfoList

SFResultInfo getFormInfoList (SFFormKey condition ,Number startRow ,Number length)

検索条件に一致するフォーム情報配列を取得します。
パラメータ
condition SFFormKey フォーム情報検索オブジェクト
startRow Number 取得開始位置(0を指定すると先頭行から取得します。)
length Number 取得件数(0を指定すると全件取得します。)
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data Array フォーム情報オブジェクト配列
 

getFormVersion

SFResultInfo getFormVersion (String formId ,Number formNo)

指定されたフォーム履歴番号のフォーム履歴情報を取得します。
パラメータ
formId String フォームID
formNo Number フォーム履歴番号
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data フォーム履歴情報オブジェクト
 

getFormVersionCount

SFResultInfo getFormVersionCount (SFFormVersionKey condition)

検索条件に一致するフォーム履歴情報の件数を取得します。
パラメータ
condition SFFormVersionKey フォーム履歴情報検索オブジェクト
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data Number 該当データ件数
 

getFormVersionList

SFResultInfo getFormVersionList (SFFormVersionKey condition ,Number startRow ,Number length)

検索条件に一致するフォーム履歴情報配列を取得します。
パラメータ
condition SFFormVersionKey フォーム履歴情報検索オブジェクト
startRow Number 取得開始位置(0を指定すると先頭行から取得します。)
length Number 取得件数(0を指定すると全件取得します。)
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data Array フォーム履歴情報オブジェクト配列
 

updateFormInfo

SFResultInfo updateFormInfo (SFFormInfo arg)

フォーム情報を更新します。
このメソッドはフォームのデプロイを行わず、フォーム名等の基本情報のみ更新する場合に使用します。
パラメータ
arg SFFormInfo フォーム情報オブジェクト
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data 更新したフォーム情報オブジェクト
 

updateVersionInfo

SFResultInfo updateVersionInfo (SFFormVersionInfo arg)

フォーム履歴情報を更新します。
このメソッドはフォームのデプロイを行わず、備考等のフォーム履歴情報を更新します。
パラメータ
arg SFFormVersionInfo フォーム履歴情報オブジェクト
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data 更新したフォーム履歴情報オブジェクト