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 import java.util.List;
39
40 /**
41 * This class provides instances management methods (create, find, ...) for file objects
42 */
43 public final class FileHome
44 {
45 // Static variable pointed at the DAO instance
46 private static IFileDAO _dao = SpringContextService.getBean( "directoryFileDAO" );
47
48 /**
49 * Private constructor - this class need not be instantiated
50 */
51 private FileHome( )
52 {
53 }
54
55 /**
56 * Creation of an instance of record file
57 *
58 * @param file
59 * The instance of the file which contains the informations to store
60 * @param plugin
61 * the plugin
62 *
63 * @return the id of the file after creation
64 *
65 */
66 public static int create( File file, Plugin plugin )
67 {
68 if ( file.getPhysicalFile( ) != null )
69 {
70 file.getPhysicalFile( ).setIdPhysicalFile( PhysicalFileHome.create( file.getPhysicalFile( ), plugin ) );
71 }
72
73 return _dao.insert( file, plugin );
74 }
75
76 /**
77 * Update of file which is specified in parameter
78 *
79 * @param file
80 * The instance of the record file which contains the informations to update
81 * @param plugin
82 * the Plugin
83 *
84 */
85 public static void update( File file, Plugin plugin )
86 {
87 if ( file.getPhysicalFile( ) != null )
88 {
89 PhysicalFileHome.update( file.getPhysicalFile( ), plugin );
90 }
91
92 _dao.store( file, plugin );
93 }
94
95 /**
96 * Delete the file whose identifier is specified in parameter
97 *
98 * @param nIdFile
99 * The identifier of the record file
100 * @param plugin
101 * the Plugin
102 */
103 public static void remove( int nIdFile, Plugin plugin )
104 {
105 File file = FileHome.findByPrimaryKey( nIdFile, plugin );
106
107 if ( file.getPhysicalFile( ) != null )
108 {
109 PhysicalFileHome.remove( file.getPhysicalFile( ).getIdPhysicalFile( ), plugin );
110 }
111
112 _dao.delete( nIdFile, plugin );
113 }
114
115 // /////////////////////////////////////////////////////////////////////////
116 // Finders
117
118 /**
119 * Returns an instance of a file whose identifier is specified in parameter
120 *
121 * @param nKey
122 * The file primary key
123 * @param plugin
124 * the Plugin
125 * @return an instance of file
126 */
127 public static File findByPrimaryKey( int nKey, Plugin plugin )
128 {
129 return _dao.load( nKey, plugin );
130 }
131
132 /**
133 * Purge the file associated to given id
134 *
135 * @param file
136 * the file to purge
137 * @param plugin
138 * The plugin
139 */
140 public static void purge( File file, Plugin plugin )
141 {
142 _dao.purge( file, plugin );
143 }
144
145 /**
146 * Get the files list
147 *
148 * @param plugin
149 * the plugin
150 * @return the list of files
151 */
152 public static List<File> getFilesList( Plugin plugin )
153 {
154 return _dao.selectFilesList( plugin );
155 }
156 }