1 /*
2 * Copyright (c) 2002-2021, City of 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
35 package fr.paris.lutece.plugins.campaign.business;
36
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38 import fr.paris.lutece.util.ReferenceList;
39 import java.util.List;
40
41 /**
42 * ICampaignDAO Interface
43 */
44 public interface ICampaignDAO
45 {
46 /**
47 * Insert a new record in the table.
48 *
49 * @param campaign
50 * instance of the Campaign object to insert
51 * @param plugin
52 * the Plugin
53 */
54 void insert( Campaign campaign, Plugin plugin );
55
56 /**
57 * Update the record in the table
58 *
59 * @param campaign
60 * the reference of the Campaign
61 * @param plugin
62 * the Plugin
63 */
64 void store( Campaign campaign, Plugin plugin );
65
66 /**
67 * Delete a record from the table
68 *
69 * @param nKey
70 * The identifier of the Campaign 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 campaign
84 * @param plugin
85 * the Plugin
86 * @return The instance of the campaign
87 */
88 Campaign load( int nKey, Plugin plugin );
89
90 /**
91 * Load the data from the table
92 *
93 * @param campaignCode
94 * The code of the campaign
95 * @param plugin
96 * the Plugin
97 * @return The instance of the campaign
98 */
99 Campaign loadByCampaignCode( String campaignCode, Plugin plugin );
100
101 /**
102 * Load the data of all the campaign objects and returns them as a list
103 *
104 * @param plugin
105 * the Plugin
106 * @return The list which contains the data of all the campaign objects
107 */
108 List<Campaign> selectCampaignsList( Plugin plugin );
109
110 /**
111 * Load the id of all the campaign objects and returns them as a list
112 *
113 * @param plugin
114 * the Plugin
115 * @return The list which contains the id of all the campaign objects
116 */
117 List<Integer> selectIdCampaignsList( Plugin plugin );
118
119 /**
120 * Load the data of all the campaign objects and returns them as a referenceList
121 *
122 * @param plugin
123 * the Plugin
124 * @return The referenceList which contains the data of all the campaign objects
125 */
126 ReferenceList selectCampaignsReferenceList( Plugin plugin );
127
128 }