SFDocumentManager オブジェクト

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

コンストラクタの概要
SFDocumentManager (String loginUserCd ,String loginGroupId)
コンストラクタ

メソッドの概要
SFResultInfo addVersion (SFDocumentVersionInfo arg)
ドキュメントの履歴情報を追加します。
SFResultInfo createDocument (SFDocumentInfo arg)
ドキュメントの新規登録を行ないます。
SFResultInfo deleteDocument (String documentId)
ドキュメント情報の削除を行ないます。
SFResultInfo deleteTableSetting (String documentId ,String objectId)
テーブル設定情報を削除します。
SFResultInfo deleteVersion (String documentId ,Number documentNo)
ドキュメント履歴情報を削除します。
SFResultInfo getDocumentInfo (String documentId)
指定されたドキュメントIDのドキュメント情報を取得します。
SFResultInfo getDocumentInfoCount (SFDocumentKey condition)
検索条件に一致するドキュメント情報の件数を取得します。
SFResultInfo getDocumentInfoList (SFDocumentKey condition ,Number startRow ,Number length)
検索条件に一致するドキュメント情報配列を取得します。
SFResultInfo getDocumentVersion (String documentId ,Number documentNo)
指定されたドキュメント履歴番号のドキュメント履歴情報を取得します。
SFResultInfo getDocumentVersionCount (SFDocumentVersionKey condition)
検索条件に一致するドキュメント履歴情報の件数を取得します。
SFResultInfo getDocumentVersionList (SFDocumentVersionKey condition ,Number startRow ,Number length)
検索条件に一致するドキュメント履歴情報配列を取得します。
SFResultInfo getTableSetting (String documentId)
テーブル設定情報を取得します。
SFResultInfo getTableSetting (String documentId ,String objectId)
テーブル設定情報を取得します。
SFResultInfo insertTableSetting (SFTableSettingInfo arg)
テーブル設定情報を登録します。
SFResultInfo updateDocument (SFDocumentInfo arg)
ドキュメント情報を更新します。
SFResultInfo updateVersion (SFDocumentVersionInfo arg)
ドキュメント履歴情報を更新します。

コンストラクタの詳細
SFDocumentManager

SFDocumentManager (String loginUserCd ,String loginGroupId)
コンストラクタ
パラメータ
loginUserCd String ログインユーザCD(必須)
loginGroupId String ログイングループID(必須)

メソッドの詳細
addVersion

SFResultInfo addVersion (SFDocumentVersionInfo arg)

ドキュメントの履歴情報を追加します。
追加する履歴情報のドキュメント番号(履歴番号)は自動的に設定されます。
追加する履歴情報のドキュメント番号(履歴番号)は「最新ドキュメント番号 + 1」となります。
パラメータ
arg SFDocumentVersionInfo ドキュメント履歴情報オブジェクト
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data 追加したドキュメントドキュメント履歴情報オブジェクト
 

createDocument

SFResultInfo createDocument (SFDocumentInfo arg)

ドキュメントの新規登録を行ないます。
このメソッドでは、ドキュメント情報のみ登録されます。(ドキュメント履歴情報は登録されません。)
ドキュメント履歴情報を登録するには、addVersion関数を利用してください。
パラメータ
arg SFDocumentInfo ドキュメント情報オブジェクト
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data 登録したドキュメント情報オブジェクト
 

deleteDocument

SFResultInfo deleteDocument (String documentId)

ドキュメント情報の削除を行ないます。
指定されたドキュメントIDのドキュメント情報および関連する履歴情報や連携情報を 全て削除します。

このメソッドではドキュメントの履歴が複数ある場合は、エラーとなります。
ドキュメントの履歴を削除する場合は、deleteVersion関数を利用してください。
パラメータ
documentId String ドキュメントID(必須)
返却値
SFResultInfo 処理結果オブジェクト

deleteTableSetting

SFResultInfo deleteTableSetting (String documentId ,String objectId)

テーブル設定情報を削除します。
パラメータ
documentId String ドキュメントID
objectId String オブジェクトID
返却値
SFResultInfo 処理結果オブジェクト

deleteVersion

SFResultInfo deleteVersion (String documentId ,Number documentNo)

ドキュメント履歴情報を削除します。
このメソッドを利用した場合、履歴情報は論理削除されます。
実データは、ドキュメントの削除を行った際にデータベースから削除されます。

このメソッドでは、履歴情報が1件しかない場合は、エラーとなります。
ドキュメントの削除をする場合は、deleteDocument関数を使用してください。
パラメータ
documentId String ドキュメントID
documentNo Number ドキュメント番号
返却値
SFResultInfo 処理結果オブジェクト

getDocumentInfo

SFResultInfo getDocumentInfo (String documentId)

指定されたドキュメントIDのドキュメント情報を取得します。
パラメータ
documentId String ドキュメントID
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data ドキュメント情報オブジェクト
 

getDocumentInfoCount

SFResultInfo getDocumentInfoCount (SFDocumentKey condition)

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

getDocumentInfoList

SFResultInfo getDocumentInfoList (SFDocumentKey condition ,Number startRow ,Number length)

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

getDocumentVersion

SFResultInfo getDocumentVersion (String documentId ,Number documentNo)

指定されたドキュメント履歴番号のドキュメント履歴情報を取得します。
パラメータ
documentId String ドキュメントID
documentNo Number ドキュメント履歴番号
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data ドキュメント履歴情報オブジェクト
 

getDocumentVersionCount

SFResultInfo getDocumentVersionCount (SFDocumentVersionKey condition)

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

getDocumentVersionList

SFResultInfo getDocumentVersionList (SFDocumentVersionKey condition ,Number startRow ,Number length)

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

getTableSetting

SFResultInfo getTableSetting (String documentId)

テーブル設定情報を取得します。
指定されたドキュメントのテーブル設定情報を取得します。
パラメータ
documentId String ドキュメントID
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data Array テーブル設定情報オブジェクト配列
 

getTableSetting

SFResultInfo getTableSetting (String documentId ,String objectId)

テーブル設定情報を取得します。
指定されたオブジェクトIDのテーブル設定情報を取得します。
パラメータ
documentId String ドキュメントID
objectId String オブジェクトID
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data テーブル設定情報情報オブジェクト
 

insertTableSetting

SFResultInfo insertTableSetting (SFTableSettingInfo arg)

テーブル設定情報を登録します。
パラメータ
arg SFTableSettingInfo テーブル設定情報オブジェクト
返却値
SFResultInfo 処理結果オブジェクト

updateDocument

SFResultInfo updateDocument (SFDocumentInfo arg)

ドキュメント情報を更新します。
ドキュメント名や備考を変更する場合に利用します。
登録フォームIDは更新できません。
パラメータ
arg SFDocumentInfo ドキュメント情報オブジェクト
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data 更新したドキュメント情報オブジェクト
 

updateVersion

SFResultInfo updateVersion (SFDocumentVersionInfo arg)

ドキュメント履歴情報を更新します。
有効期間や備考を変更する場合に利用します。
パラメータ
arg SFDocumentVersionInfo ドキュメント履歴情報オブジェクト
返却値
SFResultInfo 処理結果オブジェクト
   SFResultInfo
       └data 更新したドキュメント履歴情報オブジェクト