KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > blandware > atleap > service > core > MailTemplateManager


1 /*
2  * Copyright 2004 Blandware (http://www.blandware.com)
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.blandware.atleap.service.core;
17
18 import com.blandware.atleap.common.util.PartialCollection;
19 import com.blandware.atleap.common.util.QueryInfo;
20 import com.blandware.atleap.model.core.MailTemplate;
21
22 import java.util.Map JavaDoc;
23
24 /**
25  * <p>Business Delegate (Proxy) Interface to handle communication between web and
26  * persistence layer.
27  * </p>
28  * <p><a HREF="MailTemplateManager.java.htm"><i>View Source</i></a>
29  * </p>
30  *
31  * @author Sergey Zubtcovskii <a HREF="mailto:sergey.zubtcovskii@blandware.com">&lt;sergey.zubtcovskii@blandware.com&gt;</a>
32  * @version $Revision: 1.3 $ $Date: 2005/08/02 14:53:39 $
33  */
34 public interface MailTemplateManager extends BaseManager {
35
36     /**
37      * Performs initialization of manager
38      */
39     public void initialize();
40
41     //~ CRUD Methods ================================================================
42
43     /**
44      * Retrieves mail template with specified id
45      *
46      * @param templateId ID of template to retrieve
47      * @return Mail template or null if no mail template with specified ID exists in database
48      */
49     public MailTemplate retrieveMailTemplate(Long JavaDoc templateId);
50
51     /**
52      * Updates mail template
53      *
54      * @param mailTemplate MailTemplate to update
55      * @param linkedObjects Map of pairs <code>uri -&gt; object<code>, which link URI in the body to
56      * corresponding object (resource or page) if it exists
57      */
58     public void updateMailTemplate(MailTemplate mailTemplate, Map JavaDoc linkedObjects);
59
60
61     // ~ Additional methods ================================================================
62
63     /**
64      * Retrieves filtered/sorted collection of mail templates
65      *
66      * @param queryInfo Object that contains information about how to filter and sort data
67      * @return Collection of mail templates
68      */
69     public PartialCollection listMailTemplates(QueryInfo queryInfo);
70
71     // ~ Finders ================================================================
72
73     /**
74      * Finds mail template with specified identifier
75      *
76      * @param templateIdentifier identifier to search by
77      * @return Mail template with specified identifier or null if none was found
78      */
79     public MailTemplate findMailTemplateByIdentifier(String JavaDoc templateIdentifier);
80
81
82 }
83
Popular Tags