1 /*
2 * Copyright (c) 2002-2021, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.newsletter.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.Collection;
40 import java.util.List;
41
42 /**
43 * @author gduge
44 *
45 */
46 public interface INewsLetterTemplateDAO
47 {
48 /**
49 * Returns the list of all templates
50 *
51 * @param plugin
52 * The plugin
53 * @return the collection of all templates
54 */
55 Collection<NewsLetterTemplate> selectTemplatesList( Plugin plugin );
56
57 /**
58 * Returns the list of all templates
59 *
60 * @param strTopicType
61 * the topic type of templates
62 * @param plugin
63 * The plugin
64 * @return the reference list of the templates corresponding to the given type
65 */
66 ReferenceList selectTemplatesListByType( String strTopicType, Plugin plugin );
67
68 /**
69 * Returns a list of templates depending on the given type
70 *
71 * @param strTopicType
72 * the topic type of templates to get
73 * @param plugin
74 * The plugin
75 * @return the collection of the templates corresponding to the given topic type
76 */
77 List<NewsLetterTemplate> selectTemplatesCollectionByType( String strTopicType, Plugin plugin );
78
79 /**
80 * Insert a new record in the table.
81 *
82 * @param newsletter
83 * The Instance of the object NewsLetterTemplate
84 * @param plugin
85 * the plugin
86 */
87 void insert( NewsLetterTemplate newsletter, Plugin plugin );
88
89 /**
90 * loads the data of the newsletter's template from the table
91 *
92 * @param nTemplateId
93 * the template identifier
94 * @param plugin
95 * the plugin
96 * @return the object inserted
97 */
98 NewsLetterTemplate load( int nTemplateId, Plugin plugin );
99
100 /**
101 * Update a given record in the table.
102 *
103 * @param newsLetterTemplate
104 * The Instance of the object NewsLetterTemplate
105 * @param plugin
106 * the plugin
107 */
108 void store( NewsLetterTemplate newsLetterTemplate, Plugin plugin );
109
110 /**
111 * Remove a record from the table
112 *
113 * @param nNewsLetterTemplateId
114 * the template identifier
115 * @param plugin
116 * the Plugin
117 */
118 void delete( int nNewsLetterTemplateId, Plugin plugin );
119
120 /**
121 * Returns the list of all templates
122 *
123 * @param plugin
124 * The plugin
125 * @return the reference list of the templates
126 */
127 ReferenceList selectTemplatesByRef( Plugin plugin );
128
129 /**
130 * Get the list of temmplates associated with a given workgroup
131 *
132 * @param strWorkgroupKey
133 * The key of the workgroup
134 * @param plugin
135 * The plugin
136 * @return The list of temmplates associated with a given workgroup
137 */
138 Collection<NewsLetterTemplate> selectTemplatesListByWorkgoup( String strWorkgroupKey, Plugin plugin );
139 }