WorkflowMatterAttachmentFileManagerオブジェクト
| コンポーネント情報 | |
|---|---|
| version | 8.0.27 |
| since | 8.0.27 |
以下の機能を提供しています。
・未完了案件に添付ファイルの追加 ・未完了案件の添付ファイルリストの取得 ・未完了案件の添付ファイルバイナリの取得 ・未完了案件の添付ファイルの削除 ・完了案件に添付ファイルの追加 ・完了案件の添付ファイルリストの取得 ・完了案件の添付ファイルバイナリの取得 ・完了案件の添付ファイルの削除 ・過去案件に添付ファイルの追加 ・過去案件の添付ファイルリストの取得 ・過去案件の添付ファイルバイナリの取得 ・過去案件の添付ファイルの削除
管理する添付ファイルは、「トランザクションファイルおよび添付ファイル保存先」の設定によって永続化保存先が異なります。詳細は データ保存の設定 を参照してください。
コンストラクタの概要
| WorkflowMatterAttachmentFileManager () コンストラクタ 案件の添付ファイルを管理するマネージャを新しく生成します。 |
メソッドの概要
コンストラクタの詳細
| WorkflowMatterAttachmentFileManager ()
コンストラクタ 案件の添付ファイルを管理するマネージャを新しく生成します。
|
メソッドの詳細
WorkflowResultInfo addActvMatterAttachmentFile (WorkflowMatterAttachmentFileParamInfo param)
未完了案件に添付ファイルを追加します。
ワークフロー案件添付ファイル情報パラメータ WorkflowMatterAttachmentFileParamInfo に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 添付対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 システムファイル名は任意です。システムファイル名が未指定の場合、API内部でシステムファイル名を自動採番します。 ファイルの登録日は当該APIが実行されたシステムタイムゾーンのシステム日を登録します。 ファイルの登録者はシステムタイムゾーンのシステム日時点で、IM-共通マスタに存在するユーザのユーザコードを指定してください。 IM-共通マスタに存在しないユーザコードや多言語情報が不足しているユーザコードが指定された場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 添付ファイルの登録が完了した後、システム案件IDとシステムファイル名を ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo に格納して返却します。 ワークフロー案件添付ファイル情報パラメータにて設定した入力ストリームはcloseしません。呼び出し側でclose処理を行ってください。
パラメータ
返却値
|
WorkflowResultInfo addArcMatterAttachmentFile (WorkflowMatterAttachmentFileParamInfo param, String archiveMonth)
過去案件に添付ファイルを追加します。
ワークフロー案件添付ファイル情報パラメータ WorkflowMatterAttachmentFileParamInfo や アーカイブ年月 に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 添付対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 システムファイル名は任意です。システムファイル名が未指定の場合、API内部でシステムファイル名を自動採番します。 ファイルの登録日は当該APIが実行されたシステムタイムゾーンのシステム日を登録します。 ファイルの登録者はシステムタイムゾーンのシステム日時点で、IM-共通マスタに存在するユーザのユーザコードを指定してください。 IM-共通マスタに存在しないユーザコードや多言語情報が不足しているユーザコードが指定された場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 添付ファイルの登録が完了した後、システム案件IDとシステムファイル名を ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo に格納して返却します。 ワークフロー案件添付ファイル情報パラメータにて設定した入力ストリームはcloseしません。呼び出し側でclose処理を行ってください。
パラメータ
返却値
|
WorkflowResultInfo addCplMatterAttachmentFile (WorkflowMatterAttachmentFileParamInfo param)
完了案件に添付ファイルを追加します。
ワークフロー案件添付ファイル情報パラメータ WorkflowMatterAttachmentFileParamInfo に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 添付対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 システムファイル名は任意です。システムファイル名が未指定の場合、API内部でシステムファイル名を自動採番します。 ファイルの登録日は当該APIが実行されたシステムタイムゾーンのシステム日を登録します。 ファイルの登録者はシステムタイムゾーンのシステム日時点で、IM-共通マスタに存在するユーザのユーザコードを指定してください。 IM-共通マスタに存在しないユーザコードや多言語情報が不足しているユーザコードが指定された場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 添付ファイルの登録が完了した後、システム案件IDとシステムファイル名を ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo に格納して返却します。 ワークフロー案件添付ファイル情報パラメータにて設定した入力ストリームはcloseしません。呼び出し側でclose処理を行ってください。
パラメータ
返却値
|
WorkflowResultInfo deleteActvMatterAttachmentFile (WorkflowMatterAttachmentFileKeyInfo key)
未完了案件の添付ファイルを削除します。
ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo のシステム案件ID、システムファイル名に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 削除対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。
パラメータ
返却値
|
WorkflowResultInfo deleteArcMatterAttachmentFile (WorkflowMatterAttachmentFileKeyInfo key, String archiveMonth)
過去案件の添付ファイルを削除します。
ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo のシステム案件ID、システムファイル名、や アーカイブ年月 に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 削除対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。
パラメータ
返却値
|
WorkflowResultInfo deleteCplMatterAttachmentFile (WorkflowMatterAttachmentFileKeyInfo key)
完了案件の添付ファイルを削除します。
ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo のシステム案件ID、システムファイル名に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 削除対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。
パラメータ
返却値
|
WorkflowResultInfo getActvMatterAttachmentFile (WorkflowMatterAttachmentFileKeyInfo key)
未完了案件の添付ファイルバイナリデータを取得します。
ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo のシステム案件ID、システムファイル名 に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 取得対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。
パラメータ
返却値
|
WorkflowResultInfo getActvMatterAttachmentFiles (WorkflowMatterAttachmentFileKeyInfo key, String localeId)
未完了案件の添付ファイルリストを取得します。
ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo のシステム案件ID や ロケールID に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 取得対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。
パラメータ
返却値
|
WorkflowResultInfo getArcMatterAttachmentFile (WorkflowMatterAttachmentFileKeyInfo key, String archiveMonth)
過去案件の添付ファイルバイナリデータを取得します。
ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo のシステム案件ID、システムファイル名 や アーカイブ年月に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 取得対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。
パラメータ
返却値
|
WorkflowResultInfo getArcMatterAttachmentFiles (WorkflowMatterAttachmentFileKeyInfo key, String localeId, String archiveMonth)
過去案件の添付ファイルリストを取得します。
ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo のシステム案件ID や ロケールID、アーカイブ年月に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 取得対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。
パラメータ
返却値
|
WorkflowResultInfo getCplMatterAttachmentFile (WorkflowMatterAttachmentFileKeyInfo key)
完了案件の添付ファイルバイナリデータを取得します。
ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo のシステム案件ID、システムファイル名 に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 取得対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。
パラメータ
返却値
|
WorkflowResultInfo getCplMatterAttachmentFiles (WorkflowMatterAttachmentFileKeyInfo key, String localeId)
完了案件の添付ファイルリストを取得します。
ワークフロー案件添付ファイル情報キー WorkflowMatterAttachmentFileKeyInfo のシステム案件ID や ロケールID に値が設定されていない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。 取得対象の案件が存在しない場合は、処理に失敗しエラー情報を格納した結果オブジェクトを返却します。
パラメータ
返却値
|