1 /*
2 * Copyright (c) 2002-2017, 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.updatercatalog.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.List;
40
41
42 /**
43 * CatalogPluginDAO Interface
44 */
45 public interface ICatalogPluginDAO
46 {
47 /**
48 * Insert a new record in the table.
49 * @param catalogPlugin instance of the CatalogPlugin object to inssert
50 * @param plugin the Plugin
51 */
52 void insert( CatalogPlugin catalogPlugin, Plugin plugin );
53
54 /**
55 * Update the record in the table
56 * @param catalogPlugin the reference of the CatalogPlugin
57 * @param plugin the Plugin
58 */
59 void store( CatalogPlugin catalogPlugin, Plugin plugin );
60
61 /**
62 * Delete a record from the table
63 * @param strPluginName int identifier of the CatalogPlugin to delete
64 * @param strLocale The locale
65 * @param plugin the Plugin
66 */
67 void delete( String strPluginName, String strLocale, Plugin plugin );
68
69 ///////////////////////////////////////////////////////////////////////////
70 // Finders
71 /**
72 * Load the data from the table
73 * @param strPluginName The identifier of the catalogPlugin
74 * @param strLocale The locale
75 * @param plugin the Plugin
76 * @return The instance of the catalogPlugin
77 */
78 CatalogPlugin load( String strPluginName, String strLocale, Plugin plugin );
79
80 /**
81 * Load the data of all the catalogPlugin objects and returns them as a List
82 * @param plugin the Plugin
83 * @return The List which contains the data of all the catalogPlugin objects
84 */
85 List<CatalogPlugin> selectCatalogPluginsList( Plugin plugin );
86
87 /**
88 * Returns a list of plugins for a given locale
89 * @param plugin The plugin
90 * @param strLocale The locale as String
91 * @return The list of plugins
92 */
93 ReferenceList selectPluginsListByLocale( Plugin plugin, String strLocale );
94
95 /**
96 * Returns a list of plugins for a given locale
97 * @param plugin The plugin
98 * @param strLocale The locale
99 * @return The list of plugins
100 */
101 List<CatalogPluginEntry> selectAvailablePluginsByLocale( Plugin plugin, String strLocale );
102
103 /**
104 * Gets the list of all plugins
105 * @param plugin the plugin
106 * @return A reference list
107 */
108 ReferenceList getPlugins( Plugin plugin );
109 }