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.formengine.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 * Interface for NoticeDAO
44 *
45 */
46 public interface INoticeDAO
47 {
48 /**
49 * Insert a new notice in the table.
50 *
51 * @param notice instance of the Notice to insert
52 * @param plugin the plugin
53 * @return the id of the new notice
54 */
55 int insert( Notice notice, Plugin plugin );
56
57 /**
58 * Update the notice in the table
59 *
60 * @param notice instance of the Notice object to update
61 * @param plugin the plugin
62 */
63 void store( Notice notice, Plugin plugin );
64
65 /**
66 * Delete a record notice the table
67 *
68 * @param nIdNotice The identifier of the notice
69 * @param plugin the plugin
70 */
71 void delete( int nIdNotice, Plugin plugin );
72
73 /**
74 * Load the data of the Notice from the table
75 * @param nKey The identifier of the notice
76 * @param plugin the plugin
77 * @return the instance of the Notice
78 */
79 Notice load( int nKey, Plugin plugin );
80
81 /**
82 * Load the data of the Notice from the table
83 * @param strTitle The title of the notice
84 * @param plugin the plugin
85 * @return the instance of the Notice
86 */
87 ReferenceList getNoticeByTitle( String strTitle, Plugin plugin );
88
89 /**
90 * Load the data of all the notice who verify the filter and returns them in a list
91 * @param filter the filter
92 * @param plugin the plugin
93 * @return the list of notice
94 */
95 List<Notice> selectNoticeList( NoticeFilter filter, Plugin plugin );
96
97 /**
98 * Load the data of all enable notice returns them in a reference list
99 * @param plugin the plugin
100 * @return a reference list of notice
101 */
102 ReferenceList getEnableNoticeList( Plugin plugin );
103
104 /**
105 * Load the list of the Notice from the table
106 * @param nIdForm The id of form
107 * @param plugin the plugin
108 * @return the instance of the Notice
109 */
110 List<Notice> getNoticeByIdForm( String nIdForm, Plugin plugin );
111
112 /**
113 * Returns true if is enable false otherwise
114 *
115 * @param notice The notice
116 * @param plugin the Plugin
117 * @return true if is enable false otherwise
118 */
119 boolean isEnable( Notice notice, Plugin plugin );
120
121 /**
122 * Selects the last order for the group
123 * @param nIdNoticeGroup the notice group id
124 * @param plugin the plugin
125 * @return the max order, <code>-1</code> otherwise.
126 */
127 int selectMaxOrderByNoticeGroup( int nIdNoticeGroup, Plugin plugin );
128 }