1 /*
2 * Copyright (c) 2002-2017, 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.directory.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.portal.service.spring.SpringContextService;
38
39 import java.util.List;
40
41 /**
42 * This class provides instances management methods (create, find, ...) for IndexerAction objects
43 */
44 public final class IndexerActionHome
45 {
46 // Static variable pointed at the DAO instance
47 private static IIndexerActionDAO _dao = SpringContextService.getBean( "directoryIndexerActionDAO" );
48
49 /**
50 * Private constructor - this class need not be instantiated
51 */
52 private IndexerActionHome( )
53 {
54 }
55
56 /**
57 * Creation of an instance of Indexer Action
58 *
59 * @param indexerAction
60 * The instance of the indexer action which contains the informations to store
61 * @param plugin
62 * the Plugin
63 *
64 */
65 public static void create( IndexerAction 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 */
79 public static void update( IndexerAction indexerAction, Plugin plugin )
80 {
81 _dao.store( indexerAction, plugin );
82 }
83
84 /**
85 * Remove the indexerAction whose identifier is specified in parameter
86 *
87 * @param nId
88 * The IndexerActionId
89 * @param plugin
90 * the Plugin
91 */
92 public static void remove( int nId, Plugin plugin )
93 {
94 _dao.delete( nId, plugin );
95 }
96
97 // /////////////////////////////////////////////////////////////////////////
98 // Finders
99
100 /**
101 * Returns an instance of a IndexerAction whose identifier is specified in parameter
102 *
103 * @param nKey
104 * The indexerAction primary key
105 * @param plugin
106 * the Plugin
107 * @return an instance of IndexerAction
108 */
109 public static IndexerAction findByPrimaryKey( int nKey, Plugin plugin )
110 {
111 return _dao.load( nKey, plugin );
112 }
113
114 /**
115 * Loads the data of all the IndexerAction who verify the filter and returns them in a list
116 *
117 * @param filter
118 * the filter
119 * @param plugin
120 * the Plugin
121 * @return the list which contains the data of all the indexerAction
122 */
123 public static List<IndexerAction> getList( IndexerActionFilter filter, Plugin plugin )
124 {
125 return _dao.selectList( filter, plugin );
126 }
127 }