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.List;
40
41 /**
42 *
43 * @author kpomdagu
44 */
45 public interface ICategoryDAO
46 {
47 /**
48 * Delete a record from the table
49 *
50 * @param category
51 * The category object
52 * @param plugin
53 * The plugin
54 */
55 void delete( Category category, Plugin plugin );
56
57 /**
58 * Insert a new record in the table.
59 *
60 *
61 * @param category
62 * The Category object
63 * @param plugin
64 * The plugin
65 */
66 void insert( Category category, Plugin plugin );
67
68 /**
69 * Load the data of Category from the table
70 *
71 * @param nCategoryId
72 * The identifier of Category
73 * @param plugin
74 * The plugin
75 * @return the instance of the Category
76 */
77 Category load( int nCategoryId, Plugin plugin );
78
79 /**
80 * Load the list of categorys
81 *
82 *
83 * @param plugin
84 * The plugin
85 * @return The Collection of the Categories
86 */
87 List<Category> selectAll( Plugin plugin );
88
89 /**
90 * Update the record in the table
91 *
92 * @param category
93 * The reference of category
94 * @param plugin
95 * The plugin
96 */
97 void store( Category category, Plugin plugin );
98
99 /**
100 * Selects the list of categories associated to the specified sector
101 *
102 * @param sector
103 * The concerned sector
104 * @param plugin
105 * The plugin announce
106 * @return The collection of categories
107 */
108 List<Category> selectCategoriesForSector( Sector sector, Plugin plugin );
109
110 /**
111 * gets the categories reference list
112 *
113 * @param plugin
114 * the plugin
115 * @return the categories reference list
116 */
117 ReferenceList selectCategoriesReferenceList( Plugin plugin );
118
119 /**
120 * counts the entries for a given category form
121 *
122 * @param category
123 * the category
124 * @param plugin
125 * the plugin
126 * @return number of entries for a given category form
127 */
128 int countEntriesForCategory( Category category, Plugin plugin );
129
130 /**
131 * Count the number of published announce of a given category
132 *
133 * @param category
134 * The category to get the number of published announce of
135 * @param plugin
136 * The plugin
137 * @return The number of published announce of the category
138 */
139 int countPublishedAnnouncesForCategory( Category category, Plugin plugin );
140
141 int copyCategory( Category category, Plugin plugin );
142 }