1 /*
2 * Copyright (c) 2002-2021, 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.announce.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.Collection;
40 import java.util.Locale;
41
42 /**
43 *
44 * @author kpomdagu
45 */
46 public interface ISectorDAO
47 {
48 /**
49 * Delete a record from the table
50 *
51 * @param sector
52 * The sector object
53 * @param plugin
54 * The plugin
55 */
56 void delete( Sector sector, Plugin plugin );
57
58 /**
59 * Insert a new record in the table.
60 *
61 * @param sector
62 * The Sector object
63 * @param plugin
64 * The plugin
65 */
66 void insert( Sector sector, Plugin plugin );
67
68 /**
69 * Load the data of Sector from the table
70 *
71 * @param nSectorId
72 * The identifier of Sector
73 * @param plugin
74 * The plugin
75 * @return the instance of the Sector
76 */
77 Sector load( int nSectorId, Plugin plugin );
78
79 /**
80 * Load the list of sectors
81 *
82 *
83 * @param plugin
84 * The plugin
85 * @return The Collection of the Sectors
86 */
87 Collection<Sector> selectAll( Plugin plugin );
88
89 /**
90 * Update the record in the table
91 *
92 * @param sector
93 * The reference of sector
94 * @param plugin
95 * The plugin
96 */
97 void store( Sector sector, Plugin plugin );
98
99 /**
100 * Returns a referenceList of sectors
101 *
102 * @param plugin
103 * The Plugin object
104 * @return A referenceList of sectors
105 */
106 ReferenceList selectReferenceList( Plugin plugin );
107
108 /**
109 * selects the reference list with the i18n string at the top (for front)
110 *
111 * @param plugin
112 * The plugin
113 * @param locale
114 * The locale
115 * @return A referenceList of sectors
116 */
117 ReferenceList selectLocaleReferenceList( Plugin plugin, Locale locale );
118
119 // ////////////////////////////// Order management
120
121 /**
122 * Update the order of a sector
123 *
124 * @param nNewOrder
125 * The order of a sector
126 * @param nId
127 * The id of the sector to update
128 * @param plugin
129 * The plugin
130 */
131 void storeOrder( int nNewOrder, int nId, Plugin plugin );
132
133 /**
134 * Returns identifier in a distinct order
135 *
136 * @return The order
137 * @param nOrder
138 * The order number
139 * @param plugin
140 * The plugin
141 */
142 int selectIdByOrder( int nOrder, Plugin plugin );
143
144 /**
145 * Returns the order
146 *
147 * @param nId
148 * the id
149 * @param plugin
150 * the plugin
151 * @return the order
152 */
153 int selectOrderById( int nId, Plugin plugin );
154
155 /**
156 * Get the maximum order of sectors
157 *
158 * @param plugin
159 * The plugin
160 * @return The maximum order of sectors
161 */
162 int selectMaxOrder( Plugin plugin );
163 }