View Javadoc
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.identitystore.modules.indexer.business;
35  
36  import fr.paris.lutece.plugins.identitystore.modules.indexer.service.IdentityStoreIndexerPlugin;
37  import fr.paris.lutece.portal.service.plugin.Plugin;
38  import fr.paris.lutece.portal.service.plugin.PluginService;
39  import fr.paris.lutece.portal.service.spring.SpringContextService;
40  
41  import java.util.List;
42  
43  /**
44   * This class provides instances management methods (create, find, ...) for IndexerAction objects
45   */
46  public final class IndexerActionHome
47  {
48      // Static variable pointed at the DAO instance
49      private static IIndexerActionDAO _dao = SpringContextService.getBean( "identitystore-indexer.indexerActionDAO" );
50      private static Plugin _plugin = PluginService.getPlugin( IdentityStoreIndexerPlugin.PLUGIN_NAME );
51  
52      /**
53       * Private constructor
54       */
55      private IndexerActionHome( )
56      {
57      }
58  
59      /**
60       * Creation of an instance of Indexer Action
61       * 
62       * @param indexerAction
63       *            The instance of the indexer action which contains the informations to store
64       */
65      public static synchronized void create( IndexerAction indexerAction )
66      {
67          _dao.insert( indexerAction, _plugin );
68      }
69  
70      /**
71       * Creation of a list of IndexerAction
72       * 
73       * @param nIdTask
74       *            The id of the indexer task
75       */
76      public static synchronized void createAllByIdTask( int nIdTask )
77      {
78          _dao.insertAllByIdTask( nIdTask, _plugin );
79      }
80  
81      /**
82       * Delete all the IndexerAction with given filter
83       * 
84       * @param filter
85       *            the filter
86       */
87      public static synchronized void deleteByFilter( IndexerActionFilter filter )
88      {
89          _dao.deleteByFilter( filter, _plugin );
90      }
91  
92      /**
93       * Removes the indexerAction whose identifier is specified in parameter
94       * 
95       * @param nId
96       *            The IndexerActionId
97       */
98      public static synchronized void remove( int nId )
99      {
100         _dao.delete( nId, _plugin );
101     }
102 
103     // /////////////////////////////////////////////////////////////////////////
104     // Finders
105 
106     /**
107      * Loads the data of all the IndexerAction depending on the filter and returns them in a list
108      * 
109      * @param filter
110      *            the filter
111      * @param nStart
112      *            the started row
113      * @param nLimit
114      *            the limit ( nb of row to return )
115      * @return the list which contains the data of all the indexerAction
116      */
117     public static List<IndexerAction> getListLimit( IndexerActionFilter filter, int nStart, int nLimit )
118     {
119         return _dao.selectListLimit( filter, nStart, nLimit, _plugin );
120     }
121 }