src/main/java/com/ozacc/mail/VelocityMultipleMailBuilder.java

   1 package com.ozacc.mail;\r
   2 \r
   3 import java.io.File;\r
   4 \r
   5 import org.apache.velocity.VelocityContext;\r
   6 \r
   7 /**\r
   8  * Velocityと連携して動的にメールデータを生成し、そのデータからMailインスタンスを生成するインターフェース。\r
   9  * \r
  10  * @since 1.2\r
  11  * @author Tomohiro Otsuka\r
  12  * @version $Id: VelocityMultipleMailBuilder.java,v 1.1.2.2 2005/01/23 06:47:08 otsuka Exp $\r
  13  */\r
  14 public interface VelocityMultipleMailBuilder extends VelocityMailBuilder {\r
  15 \r
  16         /**\r
  17          * 指定されたクラスパス上のファイルを読み込み、mailIdが示すデータからMailインスタンスを生成します。\r
  18          * 指定されたVelocityContextを使って、XMLファイルの内容を動的に生成できます。\r
  19          * \r
  20          * @param classPath メール内容を記述したファイルのパス\r
  21          * @param context VelocityContext\r
  22          * @param mailId 生成するMailのメールデータを示すID\r
  23          * @return 生成されたMailインスタンス\r
  24          * @throws MailBuildException Mailインスタンスの生成に失敗した場合\r
  25          */\r
  26         Mail buildMail(String classPath, VelocityContext context, String mailId)\r
  27                                                                                                                                                         throws MailBuildException;\r
  28 \r
  29         /**\r
  30          * 指定されたファイルを読み込み、mailIdが示すデータからMailインスタンスを生成します。\r
  31          * 指定されたVelocityContextを使って、XMLファイルの内容を動的に生成できます。\r
  32          * \r
  33          * @param file メール内容を記述したファイル\r
  34          * @param context VelocityContext\r
  35          * @param mailId 生成するMailのメールデータを示すID\r
  36          * @return 生成されたMailインスタンス\r
  37          * @throws MailBuildException Mailインスタンスの生成に失敗した場合\r
  38          */\r
  39         Mail buildMail(File file, VelocityContext context, String mailId) throws MailBuildException;\r
  40 \r
  41 }