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;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.portal.service.spring.SpringContextService;
38
39 /**
40 * This class provides instances management methods (create, find, ...) for physical file objects
41 */
42 public final class PhysicalFileHome
43 {
44 // Static variable pointed at the DAO instance
45 private static IPhysicalFileDAO _dao = SpringContextService.getBean( "directoryPhysicalFileDAO" );
46
47 /**
48 * Private constructor - this class need not be instantiated
49 */
50 private PhysicalFileHome( )
51 {
52 }
53
54 /**
55 * Creation of an instance of record physical file
56 *
57 * @param physicalFile
58 * The instance of the physical file which contains the informations to store
59 * @param plugin
60 * the plugin
61 *
62 * @return the id of the file after creation
63 *
64 */
65 public static int create( PhysicalFile physicalFile, Plugin plugin )
66 {
67 return _dao.insert( physicalFile, plugin );
68 }
69
70 /**
71 * Update of physical file which is specified in parameter
72 *
73 * @param physicalFile
74 * The instance of the record physicalFile which contains the informations to update
75 * @param plugin
76 * the Plugin
77 *
78 */
79 public static void update( PhysicalFile physicalFile, Plugin plugin )
80 {
81 _dao.store( physicalFile, plugin );
82 }
83
84 /**
85 * Delete the physical file whose identifier is specified in parameter
86 *
87 * @param nIdPhysicalFile
88 * The identifier of the record physical file
89 * @param plugin
90 * the Plugin
91 */
92 public static void remove( int nIdPhysicalFile, Plugin plugin )
93 {
94 _dao.delete( nIdPhysicalFile, plugin );
95 }
96
97 // /////////////////////////////////////////////////////////////////////////
98 // Finders
99
100 /**
101 * Returns an instance of a physical file whose identifier is specified in parameter
102 *
103 * @param nKey
104 * The file primary key
105 * @param plugin
106 * the Plugin
107 * @return an instance of physical file
108 */
109 public static PhysicalFile findByPrimaryKey( int nKey, Plugin plugin )
110 {
111 return _dao.load( nKey, plugin );
112 }
113
114 /**
115 * Purge the physical file for the given idPhysicalFile
116 *
117 * @param physicalFile
118 * the physical file to purge
119 * @param plugin
120 * the plugin
121 */
122 public static void purge( PhysicalFile physicalFile, Plugin plugin )
123 {
124 _dao.purge( physicalFile, plugin );
125 }
126
127 }