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.dbpage.business;
35
36 import fr.paris.lutece.plugins.dbpage.service.DbPageContextService;
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38 import fr.paris.lutece.util.ReferenceList;
39
40 import java.util.List;
41
42
43 /**
44 * This class provides instances management methods (create, find, ...) for DbPageDatabase objects
45 */
46 public final class DbPageDatabaseHome
47 {
48 // Static variable pointed at the DAO instance
49 private static IDbPageDatabaseDAO _dao = (IDbPageDatabaseDAO) DbPageContextService.getPluginBean( "dbpage",
50 "dbPageDatabaseDAO" );
51
52 /**
53 * Private constructor - this class need not be instantiated
54 */
55 private DbPageDatabaseHome( )
56 {
57 }
58
59 /**
60 * Creation of an instance of dbPageDatabase
61 * @param plugin The plugin
62 * @return The instance of dbPageDatabase which has been created with its primary key.
63 * @param dbPageDatabase The instance of the dbPageDatabase which contains the informations to store
64 */
65 public static DbPageDatabase create( DbPageDatabase dbPageDatabase, Plugin plugin )
66 {
67 _dao.insert( dbPageDatabase, plugin );
68
69 return dbPageDatabase;
70 }
71
72 /**
73 * Update of the dbPageDatabase which is specified in parameter
74 * @param plugin The plugin
75 * @return The instance of the dbPageDatabase which has been updated
76 * @param dbPageDatabase The instance of the dbPageDatabase which contains the data to store
77 */
78 public static DbPageDatabase update( DbPageDatabase dbPageDatabase, Plugin plugin )
79 {
80 _dao.store( dbPageDatabase, plugin );
81
82 return dbPageDatabase;
83 }
84
85 /**
86 * Remove the DbPageDatabase whose identifier is specified in parameter
87 * @param plugin The plugin
88 * @param nDbPageDatabaseId The DbPageDatabase Id
89 */
90 public static void remove( int nDbPageDatabaseId, Plugin plugin )
91 {
92 _dao.delete( nDbPageDatabaseId, plugin );
93 }
94
95 ///////////////////////////////////////////////////////////////////////////
96 // Finders
97
98 /**
99 * Returns an instance of a dbPageDatabase whose identifier is specified in parameter
100 * @param plugin The plugin
101 * @return An instance of dbPageDatabase
102 * @param nKey The Primary key of the dbPageDatabase
103 */
104 public static DbPageDatabase findByPrimaryKey( int nKey, Plugin plugin )
105 {
106 return _dao.load( nKey, plugin );
107 }
108
109 /**
110 * Returns an instance of a dbPageDatabase whose identifier is specified in parameter
111 * @param plugin The plugin
112 * @return An instance of dbPageDatabase
113 * @param strName The name the dbPageDatabase
114 */
115 public static DbPageDatabase findByName( String strName, Plugin plugin )
116 {
117 return _dao.loadByName( strName, plugin );
118 }
119
120 /**
121 * Returns a referenceList of dbPageDatabases objects
122 * @param plugin The plugin
123 * @return A ReferenceList of dbPageDatabases
124 */
125 public static List<DbPageDatabase> findDbPageDatabasesList( Plugin plugin )
126 {
127 return _dao.selectDbPageDatabaseList( plugin );
128 }
129
130 /**
131 * Returns a ReferenceList of dbPageDatabases objects
132 * @param plugin The plugin
133 * @return A collection of dbPageDatabases
134 */
135 public static ReferenceList findDbPageComboList( Plugin plugin )
136 {
137 return _dao.selectDbPagesList( plugin );
138 }
139 }