AttributeHome.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.user.attribute;

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

  36. import java.util.List;
  37. import java.util.Locale;

  38. /**
  39.  *
  40.  * AttributeHome
  41.  *
  42.  */
  43. public final class AttributeHome
  44. {
  45.     private static IAttributeDAO _dao = SpringContextService.getBean( "attributeDAO" );

  46.     /**
  47.      * Private constructor
  48.      */
  49.     private AttributeHome( )
  50.     {
  51.     }

  52.     /**
  53.      * Load attribute
  54.      *
  55.      * @param nIdAttribute
  56.      *            ID Attribute
  57.      * @param locale
  58.      *            Locale
  59.      * @return Attribute
  60.      */
  61.     public static IAttribute findByPrimaryKey( int nIdAttribute, Locale locale )
  62.     {
  63.         return _dao.load( nIdAttribute, locale );
  64.     }

  65.     /**
  66.      * Insert an new attribute
  67.      *
  68.      * @param attribute
  69.      *            attribute
  70.      * @return new PK
  71.      */
  72.     public static int create( IAttribute attribute )
  73.     {
  74.         return _dao.insert( attribute );
  75.     }

  76.     /**
  77.      * Update an attribute
  78.      *
  79.      * @param attribute
  80.      *            the attribute
  81.      */
  82.     public static void update( IAttribute attribute )
  83.     {
  84.         _dao.store( attribute );
  85.     }

  86.     /**
  87.      * Delete an attribute
  88.      *
  89.      * @param nIdAttribute
  90.      *            The id of the attribute
  91.      */
  92.     public static void remove( int nIdAttribute )
  93.     {
  94.         _dao.delete( nIdAttribute );
  95.     }

  96.     /**
  97.      * Load every attributes
  98.      *
  99.      * @param locale
  100.      *            locale
  101.      * @return list of attributes
  102.      */
  103.     public static List<IAttribute> findAll( Locale locale )
  104.     {
  105.         return _dao.selectAll( locale );
  106.     }

  107.     /**
  108.      * Load every attributes associated to a plugin
  109.      *
  110.      * @param strPluginName
  111.      *            plugin name
  112.      * @param locale
  113.      *            locale
  114.      * @return list of attributes
  115.      */
  116.     public static List<IAttribute> findPluginAttributes( String strPluginName, Locale locale )
  117.     {
  118.         return _dao.selectPluginAttributes( strPluginName, locale );
  119.     }

  120.     /**
  121.      * Load every attributes that do not come from a plugin
  122.      *
  123.      * @param locale
  124.      *            locale
  125.      * @return list of attributes
  126.      */
  127.     public static List<IAttribute> findCoreAttributes( Locale locale )
  128.     {
  129.         return _dao.selectCoreAttributes( locale );
  130.     }

  131.     /**
  132.      * Update the anonymization status of the attribute.
  133.      *
  134.      * @param nIdAttribute
  135.      *            Id of the attribute
  136.      * @param bAnonymize
  137.      *            New value of the anonymization status. True means the attribute should be anonymize, false means it doesn't.
  138.      */
  139.     public static void updateAttributeAnonymization( int nIdAttribute, boolean bAnonymize )
  140.     {
  141.         _dao.updateAttributeAnonymization( nIdAttribute, bAnonymize );
  142.     }
  143. }