スクリプト開発向けim-BizAPI

WorkflowTemporaryAttachFileManagerオブジェクト

コンポーネント情報
version8.0.14
コンポーネント概要
ワークフローで一時領域に対する添付ファイルの追加や削除を管理するマネージャオブジェクトです。

このクラスは以下の機能を提供しています。

 ・一時領域ディレクトリとキーの作成
 ・一時領域ディレクトリへの添付ファイルの追加と削除
 ・一時領域ディレクトリの削除
 ・一時領域ディレクトリからファイル情報一覧の取得
 ・一時領域からファイル格納領域へのディレクトリ移動
 ・添付ファイル情報テーブルに対するデータ登録および削除

　一時領域は以下になります。
　 [%SESSION_SCOPE_STORAGE_PATH%]/im_workflow/temp/[%一時領域ディレクトリキー%]

　ファイル格納領域は以下になります。
　 [%PUBLIC_STORAGE_PATH%]/im_workflow/data/[%テナントID%]/transaction/YYYYMM/DD/HH/[%システム案件ID%]]/attachfile

HTTP セッションが無効な状況で利用する場合、WorkflowAttachFileManagerを利用してください。

メソッドの概要

返却値の型 メソッド名
WorkflowResultInfo addFileToTemp (String tempDirKey, String fileName, String fileData)
一時領域へ添付ファイルを追加します。
WorkflowResultInfo createTempDirKey ()
一時領域ディレクトリキーを作成して返却します。
WorkflowResultInfo getTempFileList (String tempDirKey)
指定した一時領域ディレクトリから、ファイル情報の一覧を取得します。
WorkflowResultInfo removeAllTempDir ()
ログインユーザID 配下の全ての一時領域ディレクトリを削除します。
WorkflowResultInfo removeTempDir (String tempDirKey)
一時領域ディレクトリを削除します (ディレクトリキー指定)。
WorkflowResultInfo removeTempFile (String tempDirKey, String systemFileName)
一時領域から指定した添付ファイルを削除します。

メソッドの詳細

WorkflowResultInfo addFileToTemp (String tempDirKey, String fileName, String fileData)
一時領域へ添付ファイルを追加します。

一時領域ディレクトリキーは、createTempDirKey メソッドで取得したキーを設定します。
ファイルの追加に成功した場合、処理結果に添付ファイル情報データモデルを
格納して返却します。
パラメータ
tempDirKey : String
一時領域ディレクトリキー
fileName : String
添付ファイル名
fileData : String
添付ファイルデータ
返却値
WorkflowResultInfo
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、
添付ファイル情報オブジェクトが設定されます。
WorkflowResultInfo createTempDirKey ()
一時領域ディレクトリキーを作成して返却します。

作成したキーで一時領域ディレクトリを作成します。
返却値
WorkflowResultInfo
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、
String 一時領域ディレクトリキーが設定されます。
WorkflowResultInfo getTempFileList (String tempDirKey)
指定した一時領域ディレクトリから、ファイル情報の一覧を取得します。

一時領域ディレクトリキーは、createTempDirKey メソッドで取得したキーを設定します。
パラメータ
tempDirKey : String
一時領域ディレクトリキー
返却値
WorkflowResultInfo
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、
添付ファイル情報オブジェクトの配列が設定されます。
WorkflowResultInfo removeAllTempDir ()
ログインユーザID 配下の全ての一時領域ディレクトリを削除します。

ディレクトリ内のファイルは全て削除されます。
返却値
WorkflowResultInfo
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。
WorkflowResultInfo removeTempDir (String tempDirKey)
一時領域ディレクトリを削除します (ディレクトリキー指定)。

ディレクトリ内のファイルは全て削除されます。
一時領域ディレクトリキーは、createTempDirKey メソッドで取得したキーを設定します。
パラメータ
tempDirKey : String
一時領域ディレクトリキー
返却値
WorkflowResultInfo
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。
WorkflowResultInfo removeTempFile (String tempDirKey, String systemFileName)
一時領域から指定した添付ファイルを削除します。

一時領域ディレクトリキーは、createTempDirKey メソッドで取得したキーを設定します。
システムファイル名は、一時領域への添付ファイル追加時に返却したデータモデル内に
保持してあるシステムファイル名を設定してください。
パラメータ
tempDirKey : String
一時領域ディレクトリキー
systemFileName : String
システムファイル名
返却値
WorkflowResultInfo
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

Copyright © 2012 NTT DATA INTRAMART CORPORATION