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.htmlpage.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.Collection;
39
40 /**
41 * htmlPageInterface
42 *
43 * @author lenaini
44 */
45 public interface IHtmlPageDAO
46 {
47 /**
48 * Delete a record from the table
49 *
50 * @param htmlpage
51 * The HtmlPage object
52 * @param plugin
53 * The plugin
54 */
55 void delete( HtmlPage htmlpage, Plugin plugin );
56
57 /**
58 * Insert a new record in the table.
59 *
60 * @param htmlpage
61 * The htmlpage object
62 * @param plugin
63 * The plugin
64 */
65 void insert( HtmlPage htmlpage, Plugin plugin );
66
67 /**
68 * Load the data of HtmlPage from the table
69 *
70 * @param nHtmlPageId
71 * The identifier of HtmlPage
72 * @param plugin
73 * The plugin
74 * @return the instance of the HtmlPage
75 */
76 HtmlPage load( int nHtmlPageId, Plugin plugin );
77
78 /**
79 * Load the data of enabled HtmlPage from the table
80 *
81 * @param nHtmlPageId
82 * The identifier of HtmlPage
83 * @param plugin
84 * The plugin
85 * @return the instance of the HtmlPage
86 */
87 HtmlPage selectEnabledHtmlPage( int nHtmlPageId, Plugin plugin );
88
89 /**
90 * Load the list of htmlpages
91 *
92 * @param plugin
93 * The plugin
94 * @return The Collection of the HtmlPages
95 */
96 Collection<HtmlPage> selectAll( Plugin plugin );
97
98 /**
99 * Load the list of htmlpages with valid status
100 *
101 * @param plugin
102 * The plugin
103 * @return The Collection of the HtmlPages
104 */
105 Collection<HtmlPage> selectEnabledHtmlPageList( Plugin plugin );
106
107 /**
108 * Update the record in the table
109 *
110 * @param htmlpage
111 * The reference of htmlpage
112 * @param plugin
113 * The plugin
114 */
115 void store( HtmlPage htmlpage, Plugin plugin );
116 }