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.search.solr.business.indexeraction;
35
36 import fr.paris.lutece.portal.business.indexeraction.IndexerActionFilter;
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38
39 import java.util.List;
40
41 /**
42 *
43 * IIndexerActionDAO
44 *
45 */
46 public interface ISolrIndexerActionDAO
47 {
48 /**
49 * Generates a new primary key
50 *
51 * @param plugin
52 * the plugin
53 * @return The new primary key
54 */
55 int newPrimaryKey( Plugin plugin );
56
57 /**
58 * Insert a new record in the table.
59 *
60 * @param indexerAction
61 * instance of the IndexerAction object to insert
62 * @param plugin
63 * the plugin
64 */
65 void insert( SolrIndexerAction indexerAction, Plugin plugin );
66
67 /**
68 * Load the data of the IndexerAction from the table
69 *
70 * @param nId
71 * The identifier of the action
72 * @param plugin
73 * the plugin
74 * @return the instance of the IndexerAction
75 */
76 SolrIndexerAction load( int nId, Plugin plugin );
77
78 /**
79 * Delete a record from the table
80 *
81 * @param nId
82 * The identifier of the action
83 * @param plugin
84 * the plugin
85 */
86 void delete( int nId, Plugin plugin );
87
88 /**
89 * Delete a record from the table
90 *
91 * @param plugin
92 * the plugin
93 *
94 */
95 void deleteAll( Plugin plugin );
96
97 /**
98 * Update the indexerAction in the table
99 *
100 * @param indexerAction
101 * instance of the IndexerAction object to update
102 * @param plugin
103 * the plugin
104 */
105 void store( SolrIndexerAction indexerAction, Plugin plugin );
106
107 /**
108 * Load the data of all indexerAction and returns them in a list
109 *
110 * @param filter
111 * the search filter
112 * @param plugin
113 * the plugin
114 * @return The List which contains the data of all action
115 */
116 List<SolrIndexerAction> selectList( IndexerActionFilter filter, Plugin plugin );
117
118 /**
119 * Load the data of all indexerAction
120 *
121 * @param plugin
122 * the plugin
123 * @return The List which contains the data of all action
124 */
125 List<SolrIndexerAction> selectList( Plugin plugin );
126 }