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.crm.business.demand.category;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.Collection;
39
40 /**
41 *
42 * ICategoryDAO Interface
43 *
44 */
45 public interface ICategoryDAO
46 {
47 /**
48 * Generates a new primary key
49 *
50 * @param plugin
51 * The Plugin
52 * @return The new primary key
53 */
54 int newPrimaryKey( Plugin plugin );
55
56 /**
57 * Insert a new record in the table.
58 *
59 * @param category
60 * instance of the Category object to insert
61 * @param plugin
62 * the Plugin
63 * @return the new primary key
64 */
65 int insert( Category category, Plugin plugin );
66
67 /**
68 * Update the record in the table
69 *
70 * @param category
71 * the reference of the Category
72 * @param plugin
73 * the Plugin
74 */
75 void store( Category category, Plugin plugin );
76
77 /**
78 * Delete a record from the table
79 *
80 * @param nIdCategory
81 * int identifier of the Category to delete
82 * @param plugin
83 * the Plugin
84 */
85 void delete( int nIdCategory, Plugin plugin );
86
87 /**
88 * Load the data from the table
89 *
90 * @param nKey
91 * The identifier of the category
92 * @param plugin
93 * the Plugin
94 * @return The instance of the category
95 */
96 Category load( int nKey, Plugin plugin );
97
98 /**
99 * Load the data of all the category objects and returns them as a collection
100 *
101 * @param plugin
102 * the Plugin
103 * @return The collection which contains the data of all the category objects
104 */
105 Collection<Category> selectCategoriesList( Plugin plugin );
106
107 /**
108 * Select the first category
109 *
110 * @param plugin
111 * {@link Plugin}
112 * @return a {@link Category
113 */
114 Category selectFirstCategory( Plugin plugin );
115
116 /**
117 * {@inheritDoc }
118 */
119 Category selectByCode( String strCode, Plugin plugin );
120 }