1 /*
2 * Copyright (c) 2002-2020, 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.participatoryideation.business.submitter;
35
36 import java.util.Collection;
37 import java.util.List;
38 import java.util.Map;
39
40 import fr.paris.lutece.portal.service.plugin.Plugin;
41
42 /**
43 * ISubmitterTypeDAO Interface
44 */
45 public interface ISubmitterTypeDAO
46 {
47 /**
48 * Insert a new record in the table.
49 *
50 * @param submitterType
51 * instance of the SubmitterType object to insert
52 * @param plugin
53 * the Plugin
54 */
55 void insert( SubmitterType submitterType, Plugin plugin );
56
57 /**
58 * Update the record in the table
59 *
60 * @param submitterType
61 * the reference of the SubmitterType
62 * @param plugin
63 * the Plugin
64 */
65 void store( SubmitterType submitterType, Plugin plugin );
66
67 /**
68 * Delete a record from the table
69 *
70 * @param nKey
71 * The identifier of the SubmitterType to delete
72 * @param plugin
73 * the Plugin
74 */
75 void delete( int nKey, Plugin plugin );
76
77 // /////////////////////////////////////////////////////////////////////////
78 // Finders
79
80 /**
81 * Load the data from the table
82 *
83 * @param nKey
84 * The identifier of the submitterType
85 * @param plugin
86 * the Plugin
87 * @return The instance of the submitterType
88 */
89 SubmitterType load( int nKey, Plugin plugin );
90
91 /**
92 * Load the data of all the submitterType objects and returns them as a collection
93 *
94 * @param plugin
95 * the Plugin
96 * @return The collection which contains the data of all the submitterType objects
97 */
98 Collection<SubmitterType> selectSubmitterTypesList( Plugin plugin );
99
100 /**
101 * Load the id of all the submitterType objects and returns them as a collection
102 *
103 * @param plugin
104 * the Plugin
105 * @return The collection which contains the id of all the submitterType objects
106 */
107 Collection<Integer> selectIdSubmitterTypesList( Plugin plugin );
108
109 /**
110 * Load the data of all the submitterType objects for campaign and returns them as a collection
111 *
112 * @param plugin
113 * the Plugin
114 * @return The collection which contains the data of all the submitterType objects
115 */
116 Collection<SubmitterType> selectSubmitterTypesListByCampaign( String strCodeCampaign, Plugin plugin );
117
118 /**
119 * Load the data from the table
120 *
121 * @param strCode
122 * The submitter type code
123 * @param plugin
124 * the Plugin
125 * @return The instance of the submitterType
126 */
127 SubmitterType load( String strCode, Plugin plugin );
128
129 /**
130 * Load the data of all the submitterType objects mapped to a campaign and returns them as a map
131 *
132 * @param plugin
133 * the Plugin
134 * @return The collection which contains the data of all the submitterType objects
135 */
136 Map<String, List<SubmitterType>> selectSubmitterTypesMapByCampaign( Plugin plugin );
137
138 }