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.webappcontainer.business;
35
36 import fr.paris.lutece.plugins.webappcontainer.service.WebappcontainerPlugin;
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38 import fr.paris.lutece.portal.service.spring.SpringContextService;
39
40 import java.util.Collection;
41
42
43 /**
44 * This class provides instances management methods (create, find, ...) for {@link Site} objects
45 */
46 public final class SiteHome
47 {
48 // Static variable pointed at the DAO instance
49 private static ISiteDAO _dao = (ISiteDAO) SpringContextService.getPluginBean( WebappcontainerPlugin.PLUGIN_NAME,
50 "siteDAO" );
51
52 /**
53 * Private constructor - this class does not need to be instantiated
54 */
55 private SiteHome( )
56 {
57 }
58
59 /**
60 * Creation of an instance of {@link Site}
61 *
62 * @param site The instance of the {@link Site} which contains the informations to store
63 * @param plugin The {@link Plugin} object
64 * @return The instance of {@link Site} which has been created with its primary key.
65 */
66 public static Site create( Site site, Plugin plugin )
67 {
68 _dao.insert( site, plugin );
69
70 return site;
71 }
72
73 /**
74 * Update of the {@link Site} which is specified in parameter
75 *
76 * @param site The instance of the {@link Site} which contains the data to store
77 * @param plugin The {@link Plugin} object
78 * @return The instance of the {@link Site} which has been updated
79 */
80 public static Site update( Site site, Plugin plugin )
81 {
82 _dao.store( site, plugin );
83
84 return site;
85 }
86
87 /**
88 * Remove the {@link Site} whose identifier is specified in parameter
89 *
90 * @param strSiteCode The {@link Site} code to remove
91 * @param plugin The {@link Plugin} object
92 */
93 public static void remove( String strSiteCode, Plugin plugin )
94 {
95 _dao.delete( strSiteCode, plugin );
96 }
97
98 ///////////////////////////////////////////////////////////////////////////
99 // Finders
100
101 /**
102 * Returns an instance of a {@link Site} whose identifier is specified in parameter
103 *
104 * @param strSiteCode The Primary key of the {@link Site} (site code)
105 * @param plugin The {@link Plugin} object
106 * @return An instance of {@link Site}
107 */
108 public static Site findByPrimaryKey( String strSiteCode, Plugin plugin )
109 {
110 Site site = _dao.load( strSiteCode, plugin );
111
112 return site;
113 }
114
115 /**
116 * Returns a collection of {@link Site} objects
117 * @param plugin The {@link Plugin} object
118 * @return A collection of {@link Site}
119 */
120 public static Collection<Site> findAll( Plugin plugin )
121 {
122 Collection<Site> listSite = _dao.selectAll( plugin );
123
124 return listSite;
125 }
126 }