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 import fr.paris.lutece.portal.service.spring.SpringContextService;
39
40 import java.util.List;
41
42 /**
43 * This class provides instances management methods (create, find, ...) for IndexerAction objects
44 */
45 public final class SolrIndexerActionHome
46 {
47 // Static variable pointed at the DAO instance
48 private static ISolrIndexerActionDAO _dao = SpringContextService.getBean( "solrIndexerActionDAO" );
49
50 /**
51 * Private constructor - this class need not be instantiated
52 */
53 private SolrIndexerActionHome( )
54 {
55 }
56
57 /**
58 * Creation of an instance of Indexer Action
59 *
60 * @param indexerAction
61 * The instance of the indexer action which contains the informations to store
62 * @param plugin
63 * The plugin
64 */
65 public static void create( SolrIndexerAction indexerAction, Plugin plugin )
66 {
67 _dao.insert( indexerAction, plugin );
68 }
69
70 /**
71 * Update of the indexerAction which is specified in parameter
72 *
73 * @param indexerAction
74 * The instance of the indexerAction which contains the informations to update
75 * @param plugin
76 * The plugin
77 */
78 public static void update( SolrIndexerAction indexerAction, Plugin plugin )
79 {
80 _dao.store( indexerAction, plugin );
81 }
82
83 /**
84 * Remove the indexerAction whose identifier is specified in parameter
85 *
86 * @param nId
87 * The IndexerActionId
88 * @param plugin
89 * The plugin
90 */
91 public static void remove( int nId, Plugin plugin )
92 {
93 _dao.delete( nId, plugin );
94 }
95
96 /**
97 * Remove the indexerAction whose identifier is specified in parameter
98 *
99 * @param plugin
100 * The plugin
101 */
102 public static void removeAll( Plugin plugin )
103 {
104 _dao.deleteAll( plugin );
105 }
106
107 ///////////////////////////////////////////////////////////////////////////
108 // Finders
109
110 /**
111 * Returns an instance of a IndexerAction whose identifier is specified in parameter
112 *
113 * @param nKey
114 * The indexerAction primary key
115 * @param plugin
116 * The plugin
117 * @return an instance of IndexerAction
118 */
119 public static SolrIndexerAction findByPrimaryKey( int nKey, Plugin plugin )
120 {
121 return _dao.load( nKey, plugin );
122 }
123
124 /**
125 * Loads the data of all the IndexerAction who verify the filter and returns them in a list
126 *
127 * @param filter
128 * the filter
129 * @param plugin
130 * The plugin
131 * @return the list which contains the data of all the indexerAction
132 */
133 public static List<SolrIndexerAction> getList( IndexerActionFilter filter, Plugin plugin )
134 {
135 return _dao.selectList( filter, plugin );
136 }
137
138 /**
139 * Loads the data of all the IndexerAction
140 *
141 * @param plugin
142 * The plugin
143 * @return the list which contains the data of all the indexerAction
144 */
145 public static List<SolrIndexerAction> getList( Plugin plugin )
146 {
147 return _dao.selectList( plugin );
148 }
149 }