1 /*
2 * Copyright (c) 2002-2015, 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
35 package fr.paris.lutece.plugins.directory.modules.exportfile.business;
36
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38 import fr.paris.lutece.portal.service.plugin.PluginService;
39 import fr.paris.lutece.portal.service.spring.SpringContextService;
40 import java.util.Collection;
41
42 /**
43 * This class provides instances management methods (create, find, ...) for File objects
44 */
45
46 public final class FileNameHome
47 {
48 // Static variable pointed at the DAO instance
49
50 private static IFileNameDAO _dao = SpringContextService.getBean( "exportfile.fileNameDAO" );
51 private static Plugin _plugin = PluginService.getPlugin( "directory_exportfile" );
52
53 /**
54 * Private constructor - this class need not be instantiated
55 */
56 private FileNameHome( )
57 {
58 }
59
60 /**
61 * Create an instance of the fileName class
62 *
63 * @param fileName
64 * The instance of the fileName which contains the informations to store
65 * @return The instance of fileName which has been created with its primary key.
66 */
67 public static FileName create( FileName fileName )
68 {
69 _dao.insert( fileName, _plugin );
70
71 return fileName;
72 }
73
74 /**
75 * Remove the fileName whose idMappingEntry is specified in parameter
76 *
77 * @param fileName
78 * The file fileName
79 */
80 public static void remove( FileName fileName )
81 {
82 _dao.delete( fileName, _plugin );
83 }
84
85 /**
86 * Remove the fileName whose idMappingEntry is specified in parameter
87 *
88 * @param nKey
89 * The file idMappingEntry
90 */
91 public static void remove( int nKey )
92 {
93 _dao.delete( nKey, _plugin );
94 }
95
96 // /////////////////////////////////////////////////////////////////////////
97 // Finders
98
99 /**
100 * Load the data of all the FileName objects and returns them in form of a collection
101 *
102 * @param nIdDirectory
103 *
104 * @return the collection which contains the data of all the file objects
105 */
106 public static Collection<FileName> getFilesList( int nIdMappingEntry )
107 {
108 return _dao.selectFilesNameList( nIdMappingEntry, _plugin );
109 }
110
111 }