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.portal.service.plugin.Plugin;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.List;
40
41 /**
42 * IBPBotDAO Interface
43 */
44 public interface IBPBotDAO
45 {
46 /**
47 * Insert a new record in the table.
48 *
49 * @param bPBot
50 * instance of the BPBot object to insert
51 * @param plugin
52 * the Plugin
53 */
54 void insert( BPBot bPBot, Plugin plugin );
55
56 /**
57 * Update the record in the table
58 *
59 * @param bPBot
60 * the reference of the BPBot
61 * @param plugin
62 * the Plugin
63 */
64 void store( BPBot bPBot, Plugin plugin );
65
66 /**
67 * Delete a record from the table
68 *
69 * @param nKey
70 * The identifier of the BPBot to delete
71 * @param plugin
72 * the Plugin
73 */
74 void delete( int nKey, Plugin plugin );
75
76 // /////////////////////////////////////////////////////////////////////////
77 // Finders
78
79 /**
80 * Load the data from the table
81 *
82 * @param nKey
83 * The identifier of the bPBot
84 * @param plugin
85 * the Plugin
86 * @return The instance of the bPBot
87 */
88 BPBot load( int nKey, Plugin plugin );
89
90 /**
91 * Load the data of all the bPBot objects and returns them as a list
92 *
93 * @param plugin
94 * the Plugin
95 * @return The list which contains the data of all the bPBot objects
96 */
97 List<BPBot> selectBPBotsList( Plugin plugin );
98
99 /**
100 * Load the data of all the bPBot objects and returns them as a referenceList
101 *
102 * @param plugin
103 * the Plugin
104 * @return The referenceList which contains the data of all the bPBot objects
105 */
106 ReferenceList selectBPBotsReferenceList( Plugin plugin );
107 }