1 /*
2 * Copyright (c) 2002-2023, 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
35 package fr.paris.lutece.plugins.vault.business;
36
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38 import fr.paris.lutece.util.ReferenceList;
39
40 import java.util.List;
41 import java.util.Optional;
42
43 /**
44 * IApplicationDAO Interface
45 */
46 public interface IApplicationDAO
47 {
48 /**
49 * Insert a new record in the table.
50 *
51 * @param application
52 * instance of the Application object to insert
53 * @param plugin
54 * the Plugin
55 */
56 void insert( Application application, Plugin plugin );
57
58 /**
59 * Update the record in the table
60 *
61 * @param application
62 * the reference of the Application
63 * @param plugin
64 * the Plugin
65 */
66 void store( Application application, Plugin plugin );
67
68 /**
69 * Delete a record from the table
70 *
71 * @param nKey
72 * The identifier of the Application to delete
73 * @param plugin
74 * the Plugin
75 */
76 void delete( int nKey, Plugin plugin );
77
78 ///////////////////////////////////////////////////////////////////////////
79 // Finders
80
81 /**
82 * Load the data from the table
83 *
84 * @param nKey
85 * The identifier of the application
86 * @param plugin
87 * the Plugin
88 * @return The instance of the application
89 */
90 Optional<Application> load( int nKey, Plugin plugin );
91
92 /**
93 * Load the data of all the application objects and returns them as a list
94 *
95 * @param plugin
96 * the Plugin
97 * @return The list which contains the data of all the application objects
98 */
99 List<Application> selectApplicationsList( Plugin plugin );
100
101 /**
102 * Load the id of all the application objects and returns them as a list
103 *
104 * @param plugin
105 * the Plugin
106 * @return The list which contains the id of all the application objects
107 */
108 List<Integer> selectIdApplicationsList( Plugin plugin );
109
110 /**
111 * Load the data of all the application objects and returns them as a referenceList
112 *
113 * @param plugin
114 * the Plugin
115 * @return The referenceList which contains the data of all the application objects
116 */
117 ReferenceList selectApplicationsReferenceList( Plugin plugin );
118
119 /**
120 * Load the data of all the avant objects and returns them as a list
121 *
122 * @param _plugin
123 * the plugin
124 * @param listIds
125 * liste of ids
126 * @return The list which contains the data of all the avant objects
127 */
128 List<Application> selectApplicationsListByIds( Plugin _plugin, List<Integer> listIds );
129 }