1 /*
2 * Copyright (c) 2002-2014, 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.folderlisting.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.portal.service.spring.SpringContextService;
38
39 import java.util.List;
40
41
42 /**
43 * This class provides instances management methods (create, find, ...) for FolderListingDatabase objects
44 */
45 public final class FolderListingDatabaseHome
46 {
47 // Static variable pointed at the DAO instance
48 private static IFolderListingDatabaseDAO _dao = (IFolderListingDatabaseDAO) SpringContextService.getPluginBean( "folderlisting",
49 "folderListingDatabaseDAO" );
50
51 /**
52 * Creation of an instance of folderListingDatabase
53 *
54 * @param folderListingDatabase The instance of the folderListingDatabase which contains the informations to store
55 * @param plugin The current plugin using this method
56 * @return The instance of folderListingDatabase which has been created with its primary key.
57 */
58 public static FolderListingDatabase create( FolderListingDatabase folderListingDatabase, Plugin plugin )
59 {
60 _dao.insert( folderListingDatabase, plugin );
61
62 return folderListingDatabase;
63 }
64
65 /**
66 * Update of the folderListingDatabase which is specified in parameter
67 *
68 * @param folderListingDatabase The instance of the folderListingDatabase which contains the data to store
69 * @param plugin The current plugin using this method
70 * @return The instance of the folderListingDatabase which has been updated
71 */
72 public static FolderListingDatabase update( FolderListingDatabase folderListingDatabase, Plugin plugin )
73 {
74 _dao.store( folderListingDatabase, plugin );
75
76 return folderListingDatabase;
77 }
78
79 /**
80 * Remove the FolderListingDatabase whose identifier is specified in parameter
81 *
82 * @param nFolderListingDatabaseId The FolderListingDatabase Id
83 * @param plugin The current plugin using this method
84 */
85 public static void remove( int nFolderListingDatabaseId, Plugin plugin )
86 {
87 _dao.delete( nFolderListingDatabaseId, plugin );
88 }
89
90 ///////////////////////////////////////////////////////////////////////////
91 // Finders
92
93 /**
94 * Returns an instance of a folderListingDatabase whose identifier is specified in parameter
95 *
96 * @param nKey The Primary key of the folderListingDatabase
97 * @param plugin The current plugin using this method
98 * @return An instance of folderListingDatabase
99 */
100 public static FolderListingDatabase findByPrimaryKey( int nKey, Plugin plugin )
101 {
102 return _dao.load( nKey, plugin );
103 }
104
105 /**
106 * Returns a list of folderListingDatabases objects
107 * @param plugin The current plugin using this method
108 * @return A list of folders in the database
109 */
110 public static List<FolderListingDatabase> findFolderListingDatabasesList( Plugin plugin )
111 {
112 return _dao.selectFolderListingDatabaseList( plugin );
113 }
114 }