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.resource.business.database;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40 /**
41 * Interface of DAO to manage database resources
42 */
43 public interface IDatabaseResourceDAO
44 {
45 /**
46 * The name of the bean of the DAO
47 */
48 String BEAN_NAME = "resource.databaseResourceDAO";
49
50 /**
51 * insert a new resource into the database
52 *
53 * @param resource
54 * The resource to creates
55 * @param plugin
56 * The plugin
57 */
58 void insert( DatabaseResource resource, Plugin plugin );
59
60 /**
61 * Updates a database resource
62 *
63 * @param resource
64 * The resource
65 * @param plugin
66 * The plugin
67 */
68 void update( DatabaseResource resource, Plugin plugin );
69
70 /**
71 * Remove a resource from the database
72 *
73 * @param nIdResource
74 * the id of the resource
75 * @param plugin
76 * the plugin
77 */
78 void delete( int nIdResource, Plugin plugin );
79
80 /**
81 * Find a resource from its primary key
82 *
83 * @param nIdResource
84 * the id of the resource
85 * @param plugin
86 * The plugin
87 * @return The resource, or null if no resource has the given primary key
88 */
89 DatabaseResource findByPrimaryKey( int nIdResource, Plugin plugin );
90
91 /**
92 * Get the list of resources
93 *
94 * @param plugin
95 * the plugin
96 * @return The list of resources
97 */
98 List<DatabaseResource> findAll( Plugin plugin );
99
100 /**
101 * Get the list of resource ids
102 *
103 * @param resourceSort
104 * The sort parameters
105 * @param plugin
106 * The plugin
107 * @return the list of resource ids
108 */
109 List<Integer> findAllId( DatabaseResourceSort resourceSort, Plugin plugin );
110
111 /**
112 * Get the list of database resources from an id list
113 *
114 * @param listId
115 * The list of ids of resources to get
116 * @param resourceSort
117 * The sort parameters
118 * @param plugin
119 * The plugin
120 * @return The list of resources
121 */
122 List<DatabaseResource> findByListId( List<Integer> listId, DatabaseResourceSort resourceSort, Plugin plugin );
123
124 /**
125 * Get the list of resources that have a given resource type
126 *
127 * @param strResourceType
128 * The resource type
129 * @param plugin
130 * The plugin
131 * @return The list of resources, or an empty list if no resource has the given resource type
132 */
133 List<DatabaseResource> findByResourceType( String strResourceType, Plugin plugin );
134 }