Package nablarch.common.mail

Interface TemplateEngineMailProcessor

All Known Implementing Classes:

FreeMarkerMailProcessor, ThymeleafMailProcessor, TinyTemplateEngineMailProcessor, VelocityMailProcessor

public interface TemplateEngineMailProcessor

テンプレートエンジンを使用したテンプレートと変数のマージ処理をするためのインターフェース。

Method Summary

Modifier and Type	Method	Description
TemplateEngineProcessedResult	process(String templateId, String lang, Map<String,Object> variables)	テンプレートIDと言語から取得されたテンプレートと変数をマージして、その結果を返す。

Method Details

process

TemplateEngineProcessedResult process(String templateId,
 String lang,
 Map<String,Object> variables)
                               throws TemplateEngineProcessingException

テンプレートIDと言語から取得されたテンプレートと変数をマージして、その結果を返す。

当メソッドが実行されたとき、まず渡されたテンプレートIDと言語をもとにテンプレートを検索する。 具体的な検索処理は当インターフェースの実装クラスによって異なるが、 例えばテンプレートIDをファイル名とみなしてファイルシステムを検索する実装が考えられる。 また、言語はオプションなので実装クラスによっては検索に使用しなくてもよい。

テンプレートを取得できたら、テンプレートと変数をマージする。 このとき、実装クラスによっては場合分けや繰り返しなどの処理をするものもある。

マージした結果をTemplateEngineProcessedResultにセットして、当メソッドの呼び出し元へ返す。

Parameters:

templateId - テンプレートID

lang - 言語（nullでもよい）

variables - 変数

Returns:

処理結果

Throws:

TemplateEngineProcessingException - テンプレートが見つからなかった場合やテンプレートと変数のマージに失敗した場合に投げられる