View Javadoc
1   /*
2    * Copyright (c) 2002-2022, 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.pluginwizard.business;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  
38  import java.util.Collection;
39  
40  /**
41   * IConfigurationKeyDAO Interface
42   */
43  public interface IConfigurationKeyDAO
44  {
45      /**
46       * Insert a new record in the table.
47       * 
48       * @param configurationKey
49       *            instance of the ConfigurationKey object to inssert
50       * @param plugin
51       *            the Plugin
52       */
53      void insert( ConfigurationKey configurationKey, Plugin plugin );
54  
55      /**
56       * Update the record in the table
57       * 
58       * @param configurationKey
59       *            the reference of the ConfigurationKey
60       * @param plugin
61       *            the Plugin
62       */
63      void store( ConfigurationKey configurationKey, Plugin plugin );
64  
65      /**
66       * Delete a record from the table
67       * 
68       * @param nIdConfigurationKey
69       *            int identifier of the ConfigurationKey to delete
70       * @param plugin
71       *            the Plugin
72       */
73      void delete( int nIdConfigurationKey, Plugin plugin );
74  
75      // /////////////////////////////////////////////////////////////////////////
76      // Finders
77  
78      /**
79       * Load the data from the table
80       * 
81       * @param nIdKey
82       *            The identifier of the configurationKey
83       * @param plugin
84       *            the Plugin
85       * @return The instance of the configurationKey
86       */
87      ConfigurationKey load( int nIdKey, Plugin plugin );
88  
89      /**
90       * Load the data of all the configurationKey objects and returns them as a collection
91       * 
92       * @param plugin
93       *            the Plugin
94       * @return The collection which contains the data of all the configurationKey objects
95       */
96      Collection<ConfigurationKey> selectConfigurationKeysList( Plugin plugin );
97  }