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.directory.business.parameter;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  import fr.paris.lutece.portal.service.spring.SpringContextService;
38  import fr.paris.lutece.util.ReferenceItem;
39  import fr.paris.lutece.util.ReferenceList;
40  
41  /**
42   *
43   * DirectoryParameterHome
44   *
45   */
46  public final class DirectoryParameterHome
47  {
48      // Static variable pointed at the DAO instance
49      private static IDirectoryParameterDAO _dao = SpringContextService.getBean( "directoryParameterDAO" );
50  
51      /**
52       * Private constructor
53       */
54      private DirectoryParameterHome( )
55      {
56      }
57  
58      /**
59       * Load all the parameter default values
60       * 
61       * @param plugin
62       *            Plugin
63       * @return a list of ReferenceItem
64       */
65      public static ReferenceList findAll( Plugin plugin )
66      {
67          return _dao.selectAll( plugin );
68      }
69  
70      /**
71       * Load the parameter value
72       * 
73       * @param strParameterKey
74       *            the parameter key
75       * @param plugin
76       *            the plugin
77       * @return The parameter value
78       */
79      public static ReferenceItem findByKey( String strParameterKey, Plugin plugin )
80      {
81          return _dao.load( strParameterKey, plugin );
82      }
83  
84      /**
85       * Update the parameter value
86       * 
87       * @param param
88       *            The parameter
89       * @param plugin
90       *            the plugin
91       */
92      public static void update( ReferenceItem param, Plugin plugin )
93      {
94          _dao.store( param, plugin );
95      }
96  
97      /**
98       * Load parameters by filter
99       * 
100      * @param filter
101      *            the filter
102      * @param plugin
103      *            the plugin
104      * @return a {@link ReferenceList}
105      */
106     public static ReferenceList findByFilter( DirectoryParameterFilter filter, Plugin plugin )
107     {
108         return _dao.selectByFilter( filter, plugin );
109     }
110 }