View Javadoc
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.campagnebp.business;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  
38  import java.util.Collection;
39  import java.util.List;
40  import java.util.Map;
41  
42  /**
43   * ICampagneThemeDAO Interface
44   */
45  public interface ICampagneThemeDAO
46  {
47      /**
48       * Insert a new record in the table.
49       * 
50       * @param campagneTheme
51       *            instance of the CampagneTheme object to insert
52       * @param plugin
53       *            the Plugin
54       */
55      void insert( CampagneTheme campagneTheme, Plugin plugin );
56  
57      /**
58       * Update the record in the table
59       * 
60       * @param campagneTheme
61       *            the reference of the CampagneTheme
62       * @param plugin
63       *            the Plugin
64       */
65      void store( CampagneTheme campagneTheme, Plugin plugin );
66  
67      /**
68       * Delete a record from the table
69       * 
70       * @param nKey
71       *            The identifier of the CampagneTheme 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 campagneTheme
85       * @param plugin
86       *            the Plugin
87       * @return The instance of the campagneTheme
88       */
89      CampagneTheme load( int nKey, Plugin plugin );
90  
91      /**
92       * Load the data from the table
93       * 
94       * @param codeTheme
95       *            The identifier of the campagneTheme
96       * @param plugin
97       *            the Plugin
98       * @return The instance of the campagneTheme
99       */
100     CampagneTheme loadByCodeTheme( String codeTheme, Plugin plugin );
101 
102     /**
103      * Load the data of all the campagneTheme objects and returns them as a collection
104      * 
105      * @param plugin
106      *            the Plugin
107      * @return The collection which contains the data of all the campagneTheme objects
108      */
109     Collection<CampagneTheme> selectCampagneThemesList( Plugin plugin );
110 
111     /**
112      * Load the id of all the campagneTheme objects and returns them as a collection
113      * 
114      * @param plugin
115      *            the Plugin
116      * @return The collection which contains the id of all the campagneTheme objects
117      */
118     Collection<Integer> selectIdCampagneThemesList( Plugin plugin );
119 
120     /**
121      * Load the data of all the campagneTheme objects for a cmapgne and returns them as a collection
122      * 
123      * @param campagneCode
124      *            Code de la campagne courante
125      * @param plugin
126      *            the Plugin
127      * @return The collection which contains the data of all the campagneTheme objects
128      */
129     Collection<CampagneTheme> selectCampagneThemesListByCampagne( String campagneCode, Plugin plugin );
130 
131     /**
132      * Load the data of all the campagneTheme objects mapped from cmapgne and returns them as a map
133      * 
134      * @param plugin
135      *            the Plugin
136      * @return The collection which contains the data of all the campagneTheme objects
137      */
138     Map<String, List<CampagneTheme>> selectCampagneThemesMapByCampagne( Plugin plugin );
139 }