1 package com.ozacc.mail;
2
3 import java.io.File;
4
5 import org.apache.velocity.VelocityContext;
6
7 /***
8 * Velocity¤ÈÏ¢·È¤·¤ÆÆ°Åª¤Ë¥á¡¼¥?¥Ç¡¼¥¿¤òÀ¸À®¤·¡¢¤½¤Î¥Ç¡¼¥¿¤«¤éMail¥¤¥ó¥¹¥¿¥ó¥¹¤òÀ¸À®¤¹¤?¥¤¥ó¥¿¡¼¥Õ¥§¡¼¥¹¡£
9 *
10 * @see com.ozacc.mail.impl.XMLVelocityMailBuilderImpl
11 * @see com.ozacc.mail.impl.JDomXMLMailBuilder
12 *
13 * @since 1.0
14 * @author Tomohiro Otsuka
15 * @version $Id: VelocityMailBuilder.java,v 1.5 2004/10/22 00:50:18 otsuka Exp $
16 */
17 public interface VelocityMailBuilder extends MailBuilder {
18
19 /***
20 * »ØÄꤵ¤?¤¿¥¯¥é¥¹¥Ñ¥¹¾å¤Î¥Õ¥¡¥¤¥?¤òÆÉ¤ß¹?¤ó¤ÇMail¥¤¥ó¥¹¥¿¥ó¥¹¤òÀ¸À®¤·¤Þ¤¹¡£
21 * »ØÄꤵ¤?¤¿VelocityContext¤ò»È¤Ã¤Æ¡¢XML¥Õ¥¡¥¤¥?¤ÎÆâÍÆ¤òưŪ¤ËÀ¸À®¤Ç¤¤Þ¤¹¡£
22 *
23 * @param classPath ¥á¡¼¥?ÆâÍÆ¤òµ½Ò¤·¤¿¥Õ¥¡¥¤¥?¤Î¥Ñ¥¹
24 * @param context VelocityContext
25 * @return À¸À®¤µ¤?¤¿Mail¥¤¥ó¥¹¥¿¥ó¥¹
26 * @throws MailBuildException Mail¥¤¥ó¥¹¥¿¥ó¥¹¤ÎÀ¸À®¤Ë¼ºÇÔ¤·¤¿¾?¹?
27 */
28 Mail buildMail(String classPath, VelocityContext context) throws MailBuildException;
29
30 /***
31 * »ØÄꤵ¤?¤¿¥Õ¥¡¥¤¥?¤òÆÉ¤ß¹?¤ó¤ÇMail¥¤¥ó¥¹¥¿¥ó¥¹¤òÀ¸À®¤·¤Þ¤¹¡£
32 * »ØÄꤵ¤?¤¿VelocityContext¤ò»È¤Ã¤Æ¡¢XML¥Õ¥¡¥¤¥?¤ÎÆâÍÆ¤òưŪ¤ËÀ¸À®¤Ç¤¤Þ¤¹¡£
33 *
34 * @param file ¥á¡¼¥?ÆâÍÆ¤òµ½Ò¤·¤¿¥Õ¥¡¥¤¥?
35 * @param context VelocityContext
36 * @return À¸À®¤µ¤?¤¿Mail¥¤¥ó¥¹¥¿¥ó¥¹
37 * @throws MailBuildException Mail¥¤¥ó¥¹¥¿¥ó¥¹¤ÎÀ¸À®¤Ë¼ºÇÔ¤·¤¿¾?¹?
38 */
39 Mail buildMail(File file, VelocityContext context) throws MailBuildException;
40
41 /***
42 * ¼ÂÁõ¥¯¥é¥¹¤Î¥¤¥ó¥¹¥¿¥ó¥¹¤Ëͽ¤á¥»¥Ã¥È¤µ¤?¤¿¥úÁ±¡¼¥·¥ç¥ó¤Ë¤¢¤?XML¥Ç¡¼¥¿¤òÆÉ¤ß¹?¤ó¤Ç
43 * Mail¥¤¥ó¥¹¥¿¥ó¥¹¤òÀ¸À®¤·¤Þ¤¹¡£
44 * »ØÄꤵ¤?¤¿VelocityContext¤ò»È¤Ã¤Æ¡¢XML¥Õ¥¡¥¤¥?¤ÎÆâÍÆ¤òưŪ¤ËÀ¸À®¤Ç¤¤Þ¤¹¡£
45 *
46 * @param context VelocityContext
47 * @return À¸À®¤µ¤?¤¿Mail¥¤¥ó¥¹¥¿¥ó¥¹
48 * @throws MailBuildException Mail¥¤¥ó¥¹¥¿¥ó¥¹¤ÎÀ¸À®¤Ë¼ºÇÔ¤·¤¿¾?¹?
49 */
50
51 /***
52 * ¥á¡¼¥?¥Ç¡¼¥¿¥¥ã¥Ã¥·¥å¤ò¥¯¥?¥¢¤·¤Þ¤¹¡£
53 *
54 * @since 1.1.2
55 */
56 void clearCache();
57
58 /***
59 * VelocityContext¤È¥Þ¡¼¥¸¤¹¤?Á°¤Î¥á¡¼¥?¥Ç¡¼¥¿¤ò¥¥ã¥Ã¥·¥å¤¹¤?¤«¤É¤¦¤«¤òÀßÄꤷ¤Þ¤¹¡£
60 * ¥Ç¥Õ¥©¥?¥È¤Ï¥¥ã¥Ã¥·¥å¤·¤Ê¤¤ÀßÄê¤Ç¤¹¡£
61 * <p>
62 * ¥¥ã¥Ã¥·¥å¤Î¥¡¼¤Ï¡¢<code>buildMail()</code>¥á¥½¥Ã¥É°ú¿ô¤Î¥á¡¼¥?¥Ç¡¼¥¿¥Õ¥¡¥¤¥?¤Î¥¯¥é¥¹¥Ñ¥¹°¿¤¤¤Ï¥Õ¥¡¥¤¥?¥Ñ¥¹¤Ç¤¹¡£
63 * ¥¥ã¥Ã¥·¥å¤Ë͸ú´?¸Â¤Ï¤¢¤ê¤Þ¤»¤ó¡£
64 * ¤Þ¤¿¡¢¥á¡¼¥?¥Ç¡¼¥¿¥Õ¥¡¥¤¥?¤ÎÆâÍÆ¤¬ÅÓÃæ¤Ç¹¹¿·¤µ¤?¤Æ¤â¡¢¥¥ã¥Ã¥·¥å¤µ¤?¤Æ¤¤¤?¥á¡¼¥?¥Ç¡¼¥¿¤Ï¹¹¿·¤µ¤?¤Þ¤»¤ó¤Î¤ÇÃúÌÕ¤·¤Æ¤¯¤À¤µ¤¤¡£
65 * <p>
66 * <code>false</code>¤ò»ØÄꤷ¤Æ¤³¤Î¥á¥½¥Ã¥É¤ò¸Æ¤Ö¤È¥á¡¼¥?¥Ç¡¼¥¿¥¥ã¥Ã¥·¥å¤Ï¥¯¥?¥¢¤µ¤?¤Þ¤¹¡£
67 *
68 * @since 1.1.2
69 * @param cacheEnabled ¥á¡¼¥?¥Ç¡¼¥¿¤ò¥¥ã¥Ã¥·¥å¤¹¤?¾?¹ç¤Ï true
70 */
71 void setCacheEnabled(boolean cacheEnabled);
72
73 /***
74 * VelocityContext¤È¥Þ¡¼¥¸¤¹¤?Á°¤Î¥á¡¼¥?¥Ç¡¼¥¿¤ò¥¥ã¥Ã¥·¥å¤¹¤?ÀßÄ꤫¤É¤¦¤«È½Äꤷ¤Þ¤¹¡£
75 *
76 * @since 1.1.2
77 * @return ¥á¡¼¥?¥Ç¡¼¥¿¤ò¥¥ã¥Ã¥·¥å¤¹¤?ÀßÄê¤Î¾?¹ç¤Ï true
78 */
79 boolean isCacheEnabled();
80
81 }