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.service.parameter;
35  
36  import fr.paris.lutece.plugins.directory.business.parameter.EntryParameterHome;
37  import fr.paris.lutece.plugins.directory.utils.DirectoryUtils;
38  import fr.paris.lutece.portal.service.spring.SpringContextService;
39  import fr.paris.lutece.util.ReferenceItem;
40  import fr.paris.lutece.util.ReferenceList;
41  
42  /**
43   *
44   * DirectoryParameterService
45   *
46   */
47  public final class EntryParameterService
48  {
49      private static final String BEAN_ENTRY_PARAMETER_SERVICE = "directory.entryParameterService";
50  
51      /**
52       * Get the instance of the service
53       * 
54       * @return the instance of the service
55       */
56      public static EntryParameterService getService( )
57      {
58          return SpringContextService.getBean( BEAN_ENTRY_PARAMETER_SERVICE );
59      }
60  
61      /**
62       * Find all directory parameters
63       * 
64       * @return a {@link ReferenceList}
65       */
66      public ReferenceList findAll( )
67      {
68          return EntryParameterHome.findAll( DirectoryUtils.getPlugin( ) );
69      }
70  
71      /**
72       * Load the parameter value
73       * 
74       * @param strParameterKey
75       *            the parameter key
76       * @return The parameter value
77       */
78      public ReferenceItem findByKey( String strParameterKey )
79      {
80          return EntryParameterHome.findByKey( strParameterKey, DirectoryUtils.getPlugin( ) );
81      }
82  
83      /**
84       * Update the parameter value
85       * 
86       * @param param
87       *            The parameter
88       */
89      public void update( ReferenceItem param )
90      {
91          EntryParameterHome.update( param, DirectoryUtils.getPlugin( ) );
92      }
93  }