PhysicalFileHome.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.physicalfile;

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

  36. /**
  37.  * This class provides instances management methods (create, find, ...) for physical file objects
  38.  */
  39. public final class PhysicalFileHome
  40. {
  41.     // Static variable pointed at the DAO instance
  42.     private static IPhysicalFileDAO _dao = SpringContextService.getBean( "physicalFileDAO" );

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

  49.     /**
  50.      * Creation of an instance of record physical file
  51.      *
  52.      * @param physicalFile
  53.      *            The instance of the physical file which contains the informations to store
  54.      *
  55.      * @return the id of the file after creation
  56.      *
  57.      */
  58.     public static int create( PhysicalFile physicalFile )
  59.     {
  60.         return _dao.insert( physicalFile );
  61.     }

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

  73.     /**
  74.      * Delete the physical file whose identifier is specified in parameter
  75.      *
  76.      * @param nIdPhysicalFile
  77.      *            The identifier of the record physical file
  78.      */
  79.     public static void remove( int nIdPhysicalFile )
  80.     {
  81.         _dao.delete( nIdPhysicalFile );
  82.     }

  83.     // /////////////////////////////////////////////////////////////////////////
  84.     // Finders

  85.     /**
  86.      * Returns an instance of a physical file whose identifier is specified in parameter
  87.      *
  88.      * @param nKey
  89.      *            The file primary key
  90.      * @return an instance of physical file
  91.      */
  92.     public static PhysicalFile findByPrimaryKey( int nKey )
  93.     {
  94.         return _dao.load( nKey );
  95.     }
  96. }