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
38 import java.util.List;
39
40
41 /**
42 * ICatalogDAO Interface
43 */
44 public interface ICatalogDAO
45 {
46 /**
47 * Insert a new record in the table.
48 * @param catalog instance of the Catalog object to inssert
49 * @param plugin the Plugin
50 */
51 void insert( Catalog catalog, Plugin plugin );
52
53 /**
54 * Update the record in the table
55 * @param catalog the reference of the Catalog
56 * @param plugin the Plugin
57 */
58 void store( Catalog catalog, Plugin plugin );
59
60 /**
61 * Delete a record from the table
62 * @param nIdCatalog int identifier of the Catalog to delete
63 * @param plugin the Plugin
64 */
65 void delete( int nIdCatalog, Plugin plugin );
66
67 ///////////////////////////////////////////////////////////////////////////
68 // Finders
69 /**
70 * Load the data from the table
71 * @param nKey The identifier of the catalog
72 * @param plugin the Plugin
73 * @return The instance of the catalog
74 */
75 Catalog load( int nKey, Plugin plugin );
76
77 /**
78 * Load the data of all the catalog objects and returns them as a List
79 * @param plugin the Plugin
80 * @return The List which contains the data of all the catalog objects
81 */
82 List<Catalog> selectCatalogsList( Plugin plugin );
83
84 /**
85 * Load plugins entries
86 * @param nCatalogId Catalog Id
87 * @param plugin The plugin
88 * @return The List which contains the data of all the catalogs
89 */
90 List<CatalogPluginEntry> selectPluginsEntries( int nCatalogId, Plugin plugin );
91
92 /**
93 * Add a plugin release to a given catalog
94 * @param nCatalogId The catalog ID
95 * @param nReleaseId The Release Id
96 * @param plugin The plugin
97 */
98 void addRelease( int nCatalogId, int nReleaseId, Plugin plugin );
99
100 /**
101 * Remove a plugin release from a given catalog
102 * @param nCatalogId The catalog ID
103 * @param nReleaseId The Release Id
104 * @param plugin The plugin
105 */
106 void removeRelease( int nCatalogId, int nReleaseId, Plugin plugin );
107 }