View Javadoc
1   /*
2    * Copyright (c) 2002-2025, 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  
35  
36   package fr.paris.lutece.plugins.elasticdatasearch.business;
37  
38  import fr.paris.lutece.portal.service.plugin.Plugin;
39  import fr.paris.lutece.portal.service.plugin.PluginService;
40  import fr.paris.lutece.portal.service.spring.SpringContextService;
41  import fr.paris.lutece.util.ReferenceList;
42  
43  
44  import java.util.List;
45  import java.util.Map;
46  import java.util.Optional;
47  
48  /**
49   * This class provides instances management methods (create, find, ...) for Fieldsearch objects
50   */
51  public final class FieldsearchHome
52  {
53      // Static variable pointed at the DAO instance
54      private static IFieldsearchDAO _dao = SpringContextService.getBean( "elasticdatasearch.fieldsearchDAO" );
55      private static Plugin _plugin = PluginService.getPlugin( "elasticdatasearch" );
56  
57      /**
58       * Private constructor - this class need not be instantiated
59       */
60      private FieldsearchHome(  )
61      {
62      }
63  
64      /**
65       * Create an instance of the fieldsearch class
66       * @param fieldsearch The instance of the Fieldsearch which contains the informations to store
67       * @return The  instance of fieldsearch which has been created with its primary key.
68       */
69      public static Fieldsearch../../../../../fr/paris/lutece/plugins/elasticdatasearch/business/Fieldsearch.html#Fieldsearch">Fieldsearch create( Fieldsearch fieldsearch )
70      {
71          _dao.insert( fieldsearch, _plugin );
72  
73          return fieldsearch;
74      }
75  
76      /**
77       * Update of the fieldsearch which is specified in parameter
78       * @param fieldsearch The instance of the Fieldsearch which contains the data to store
79       * @return The instance of the  fieldsearch which has been updated
80       */
81      public static Fieldsearch../../../../../fr/paris/lutece/plugins/elasticdatasearch/business/Fieldsearch.html#Fieldsearch">Fieldsearch update( Fieldsearch fieldsearch )
82      {
83          _dao.store( fieldsearch, _plugin );
84  
85          return fieldsearch;
86      }
87  
88      /**
89       * Remove the fieldsearch whose identifier is specified in parameter
90       * @param nKey The fieldsearch Id
91       */
92      public static void remove( int nKey )
93      {
94          _dao.delete( nKey, _plugin );
95      }
96  
97      /**
98       * Returns an instance of a fieldsearch whose identifier is specified in parameter
99       * @param nKey The fieldsearch primary key
100      * @return an instance of Fieldsearch
101      */
102     public static Optional<Fieldsearch> findByPrimaryKey( int nKey )
103     {
104         return _dao.load( nKey, _plugin );
105     }
106 
107     /**
108      * Load the data of all the fieldsearch objects and returns them as a list
109      * @return the list which contains the data of all the fieldsearch objects
110      */
111     public static List<Fieldsearch> getFieldsearchsList( )
112     {
113         return _dao.selectFieldsearchsList( _plugin );
114     }
115     
116         /**
117      * Load the id of all the fieldsearch objects and returns them as a list
118      * @param mapFilterCriteria contains search bar names/values inputs 
119      * @param strColumnToOrder contains the column name to use for orderBy statement in case of sorting request (must be null)
120      * @param strSortMode contains the sortMode in case of sorting request : ASC or DESC (must be null)
121      * @return the list which contains the id of all the project objects
122      */
123     public static List<Integer> getIdFieldsearchsList( Map <String,String> mapFilterCriteria, String strColumnToOrder, String strSortMode )
124     {
125         return _dao.selectIdFieldsearchsList( _plugin,mapFilterCriteria,strColumnToOrder,strSortMode );
126     }
127     
128     /**
129      * Load the data of all the fieldsearch objects and returns them as a referenceList
130      * @return the referenceList which contains the data of all the fieldsearch objects
131      */
132     public static ReferenceList getFieldsearchsReferenceList( )
133     {
134         return _dao.selectFieldsearchsReferenceList( _plugin );
135     }
136     
137 	
138     /**
139      * Load the data of all the avant objects and returns them as a list
140      * @param listIds liste of ids
141      * @return the list which contains the data of all the avant objects
142      */
143     public static List<Fieldsearch> getFieldsearchsListByIds( List<Integer> listIds )
144     {
145         return _dao.selectFieldsearchsListByIds( _plugin, listIds );
146     }
147 
148 }
149