1 /*
2 * Copyright (c) 2002-2019, 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.botpress.business;
35
36 import fr.paris.lutece.plugins.botpress.service.BotInstance;
37 import fr.paris.lutece.plugins.botpress.service.BotRegistrationService;
38 import fr.paris.lutece.portal.service.plugin.Plugin;
39 import fr.paris.lutece.portal.service.plugin.PluginService;
40 import fr.paris.lutece.portal.service.spring.SpringContextService;
41 import fr.paris.lutece.util.ReferenceList;
42
43 import java.util.List;
44
45 /**
46 * This class provides instances management methods (create, find, ...) for BPBot objects
47 */
48 public final class BPBotHome
49 {
50 // Static variable pointed at the DAO instance
51 private static IBPBotDAO _dao = SpringContextService.getBean( "botpress.bPBotDAO" );
52 private static Plugin _plugin = PluginService.getPlugin( "botpress" );
53
54 /**
55 * Private constructor - this class need not be instantiated
56 */
57 private BPBotHome( )
58 {
59 }
60
61 /**
62 * Create an instance of the bPBot class
63 *
64 * @param bot
65 * The instance of the BPBot which contains the informations to store
66 * @return The instance of bPBot which has been created with its primary key.
67 */
68 public static BPBotf="../../../../../../fr/paris/lutece/plugins/botpress/business/BPBot.html#BPBot">BPBot create( BPBot bot )
69 {
70 _dao.insert( bot, _plugin );
71 BotRegistrationService.register( new BotInstance( bot ), bot.getBotStatus( ) );
72
73 return bot;
74 }
75
76 /**
77 * Update of the bPBot which is specified in parameter
78 *
79 * @param bot
80 * The instance of the BPBot which contains the data to store
81 * @return The instance of the bPBot which has been updated
82 */
83 public static BPBotf="../../../../../../fr/paris/lutece/plugins/botpress/business/BPBot.html#BPBot">BPBot update( BPBot bot )
84 {
85 _dao.store( bot, _plugin );
86 BotRegistrationService.unregister( bot.getBotKey( ) );
87 BotRegistrationService.register( new BotInstance( bot ), bot.getBotStatus( ) );
88
89 return bot;
90 }
91
92 /**
93 * Remove the bPBot whose identifier is specified in parameter
94 *
95 * @param nKey
96 * The bPBot Id
97 */
98 public static void remove( int nKey )
99 {
100 _dao.delete( nKey, _plugin );
101 }
102
103 /**
104 * Returns an instance of a bPBot whose identifier is specified in parameter
105 *
106 * @param nKey
107 * The bPBot primary key
108 * @return an instance of BPBot
109 */
110 public static BPBot findByPrimaryKey( int nKey )
111 {
112 return _dao.load( nKey, _plugin );
113 }
114
115 /**
116 * Load the data of all the bPBot objects and returns them as a list
117 *
118 * @return the list which contains the data of all the bPBot objects
119 */
120 public static List<BPBot> getBPBotsList( )
121 {
122 return _dao.selectBPBotsList( _plugin );
123 }
124
125 /**
126 * Load the data of all the bPBot objects and returns them as a referenceList
127 *
128 * @return the referenceList which contains the data of all the bPBot objects
129 */
130 public static ReferenceList getBPBotsReferenceList( )
131 {
132 return _dao.selectBPBotsReferenceList( _plugin );
133 }
134 }