DataExportExecutorオブジェクト

コンポーネント情報
version	8.0.0
since	8.0

コンポーネント概要

エクスポート処理実行APIです。

コンストラクタの概要

DataExportExecutor () コンストラクタ。

メソッドの概要

返却値の型	メソッド名
ResultObject	exportData (String `exporterId`, ByteWriter `stream`, Object `option`) エクスポート処理を実行します。
ResultObject	getExporterConfig (String `exporterId`) 指定されたエクスポータ `ID` のエクスポータの設定情報を取得します。
ResultObject	getExporterConfigs () 設定されているすべてのエクスポータの設定情報を取得します。

コンストラクタの詳細

DataExportExecutor ()

コンストラクタ。

メソッドの詳細

ResultObject exportData (String exporterId, ByteWriter stream, Object option)

エクスポート処理を実行します。
実行されるエクスポート処理はプラグインとして定義され、次のキー情報によって決定されます。

拡張ポイント ID："jp.co.intra_mart.foundation.data.exporter.DataExporter"
プラグイン ID：第一引数で渡したエクスポータID

エクスポートオプションとして指定可能なパラメータは、上記プラグインで定義されます。
プラグインで定義された指定可能なパラメータは、 DataExportExecutor#getExporterConfig(String) で取得可能です。
実行するエクスポート処理にあわせて、第三引数のエクスポートオプション（key = value 形式の Object）を指定してください。
第二引数には、ByteWriter を指定します。
ByteWriter の取得に関しては、 PublicStorage も併せて参照してください。

パラメータ

exporterId : String: エクスポータ ID

stream : ByteWriter: 出力ストリーム

option : Object: エクスポートオプション

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはエクスポート処理結果情報が設定されます。

ResultObject getExporterConfig (String exporterId)

指定されたエクスポータ ID のエクスポータの設定情報を取得します。

パラメータ

exporterId : String: エクスポータ ID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはエクスポータ設定情報が設定されます。

ResultObject getExporterConfigs ()

設定されているすべてのエクスポータの設定情報を取得します。

返却値

ResultObject: ResultObject
data プロパティにはエクスポータ設定情報の配列が設定されます。