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.formengine.business.mail;
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 MailConfiguration objects
44 */
45 public final class MailConfigurationHome
46 {
47 // Static variable pointed at the DAO instance
48 private static IMailConfigurationDAO _dao = (IMailConfigurationDAO) SpringContextService.getPluginBean( "formengine",
49 "formengine.mailConfigurationDAO" );
50
51 /**
52 * Private constructor - this class need not be instantiated
53 */
54 private MailConfigurationHome( )
55 {
56 }
57
58 /**
59 * Create an instance of the mailConfiguration class
60 * @param mailConfiguration The instance of the MailConfiguration which contains the informations to store
61 * @param plugin the Plugin
62 * @return The instance of mailConfiguration which has been created with its primary key.
63 */
64 public static MailConfiguration create( MailConfiguration mailConfiguration, Plugin plugin )
65 {
66 _dao.insert( mailConfiguration, plugin );
67
68 return mailConfiguration;
69 }
70
71 /**
72 * Update of the mailConfiguration which is specified in parameter
73 * @param mailConfiguration The instance of the MailConfiguration which contains the data to store
74 * @param plugin the Plugin
75 * @return The instance of the mailConfiguration which has been updated
76 */
77 public static MailConfiguration update( MailConfiguration mailConfiguration, Plugin plugin )
78 {
79 _dao.store( mailConfiguration, plugin );
80
81 return mailConfiguration;
82 }
83
84 /**
85 * Remove the mailConfiguration whose identifier is specified in parameter
86 * @param strForm The mailConfiguration Id
87 * @param plugin the Plugin
88 */
89 public static void remove( String strForm, Plugin plugin )
90 {
91 _dao.delete( strForm, plugin );
92 }
93
94 ///////////////////////////////////////////////////////////////////////////
95 // Finders
96
97 /**
98 * Returns an instance of a mailConfiguration whose identifier is specified in parameter
99 * @param strForm The mailConfiguration primary key
100 * @param plugin the Plugin
101 * @return an instance of MailConfiguration
102 */
103 public static MailConfiguration findByPrimaryKey( String strForm, Plugin plugin )
104 {
105 return _dao.load( strForm, plugin );
106 }
107
108 /**
109 * Load the data of all the mailConfiguration objects and returns them in form of a list
110 * @param plugin the Plugin
111 * @return the list which contains the data of all the mailConfiguration objects
112 */
113 public static List<MailConfiguration> getMailConfigurationsList( Plugin plugin )
114 {
115 return _dao.selectMailConfigurationsList( plugin );
116 }
117 }