View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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.theme.business;
35  
36  import fr.paris.lutece.portal.business.style.Theme;
37  import fr.paris.lutece.portal.service.plugin.Plugin;
38  import fr.paris.lutece.util.ReferenceList;
39  
40  import java.util.Collection;
41  
42  
43  /**
44   * This class provides Data Access methods for Theme objects
45   */
46  public interface IThemeDAO
47  {
48      /**
49       * Insert a new record in the table.
50       *
51       * @param mode The mode object
52       * @param plugin Plugin
53       */
54      void insert( Theme mode, Plugin plugin );
55  
56      /**
57       * load the data of Level from the table
58       *
59       * @param strCodeTheme The indentifier of the object Theme
60       * @param plugin Plugin
61       * @return The Instance of the object Theme
62       */
63      Theme load( String strCodeTheme, Plugin plugin );
64  
65      /**
66       * Delete a record from the table
67       *
68       * @param strCodeTheme The indentifier of the object Theme
69       * @param plugin Plugin
70       */
71      void delete( String strCodeTheme, Plugin plugin );
72  
73      /**
74       * Update the record in the table
75       *
76       * @param theme The instance of the Theme to update
77       * @param plugin Plugin
78       */
79      void store( Theme theme, Plugin plugin );
80  
81      /**
82       * Returns a list of all the themes
83       *
84       * @param plugin Plugin
85       * @return A collection of themes objects
86       */
87      Collection<Theme> selectThemesList( Plugin plugin );
88  
89      /**
90       * Returns the list of the themes in form of a reference list
91       *
92       * @param plugin Plugin
93       * @return the themes list in form of a ReferenceList object
94       */
95      ReferenceList getThemesList( Plugin plugin );
96  
97      /**
98       * Sets the global theme
99       *
100      * @param strGlobalTheme The Global Theme
101      * @param plugin Plugin
102      */
103     void setGlobalTheme( String strGlobalTheme, Plugin plugin );
104 
105     /**
106      * Returns the global theme
107      *
108      * @param plugin Plugin
109      * @return The Global Theme
110      */
111     Theme getGlobalTheme( Plugin plugin );
112 }