IndexerActionHome.java

  1. /*
  2.  * Copyright (c) 2002-2022, 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.portal.business.indexeraction;

  35. import fr.paris.lutece.portal.service.spring.SpringContextService;

  36. import java.util.List;

  37. /**
  38.  * This class provides instances management methods (create, find, ...) for IndexerAction objects
  39.  */
  40. public final class IndexerActionHome
  41. {
  42.     // Static variable pointed at the DAO instance
  43.     private static IIndexerActionDAO _dao = SpringContextService.getBean( "indexerActionDAO" );

  44.     /**
  45.      * Private constructor - this class need not be instantiated
  46.      */
  47.     private IndexerActionHome( )
  48.     {
  49.     }

  50.     /**
  51.      * Creation of an instance of Indexer Action
  52.      *
  53.      * @param indexerAction
  54.      *            The instance of the indexer action which contains the informations to store
  55.      *
  56.      */
  57.     public static void create( IndexerAction indexerAction )
  58.     {
  59.         _dao.insert( indexerAction );
  60.     }

  61.     /**
  62.      * Update of the indexerAction which is specified in parameter
  63.      *
  64.      * @param indexerAction
  65.      *            The instance of the indexerAction which contains the informations to update
  66.      *
  67.      */
  68.     public static void update( IndexerAction indexerAction )
  69.     {
  70.         _dao.store( indexerAction );
  71.     }

  72.     /**
  73.      * Remove the indexerAction whose identifier is specified in parameter
  74.      *
  75.      * @param nId
  76.      *            The IndexerActionId
  77.      */
  78.     public static void remove( int nId )
  79.     {
  80.         _dao.delete( nId );
  81.     }

  82.     /**
  83.      * Remove the indexerAction whose identifier is specified in parameter
  84.      *
  85.      */
  86.     public static void removeAll( )
  87.     {
  88.         _dao.deleteAll( );
  89.     }

  90.     // /////////////////////////////////////////////////////////////////////////
  91.     // Finders

  92.     /**
  93.      * Returns an instance of a IndexerAction whose identifier is specified in parameter
  94.      *
  95.      * @param nKey
  96.      *            The indexerAction primary key
  97.      * @return an instance of IndexerAction
  98.      */
  99.     public static IndexerAction findByPrimaryKey( int nKey )
  100.     {
  101.         return _dao.load( nKey );
  102.     }

  103.     /**
  104.      * Loads the data of all the IndexerAction who verify the filter and returns them in a list
  105.      *
  106.      * @param filter
  107.      *            the filter
  108.      * @return the list which contains the data of all the indexerAction
  109.      */
  110.     public static List<IndexerAction> getList( IndexerActionFilter filter )
  111.     {
  112.         return _dao.selectList( filter );
  113.     }

  114.     /**
  115.      * Loads the data of all the IndexerAction
  116.      *
  117.      * @return the list which contains the data of all the indexerAction
  118.      */
  119.     public static List<IndexerAction> getList( )
  120.     {
  121.         return _dao.selectList( );
  122.     }
  123. }