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 package fr.paris.lutece.plugins.subscribe.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.Collection;
39 import java.util.List;
40
41 /**
42 * Interface for subscriber DAO
43 */
44
45 public interface ISubscriptionDAO
46 {
47 /**
48 * Insert a new record in the table.
49 *
50 * @param subscription
51 * instance of the Subscription object to insert
52 * @param plugin
53 * the Plugin
54 */
55 void insert( Subscription subscription, Plugin plugin );
56
57 /**
58 * Update the record in the table
59 *
60 * @param subscription
61 * the reference of the Subscription
62 * @param plugin
63 * the Plugin
64 */
65 void store( Subscription subscription, Plugin plugin );
66
67 /**
68 * Delete a record from the table
69 *
70 * @param nIdSubscription
71 * int identifier of the Subscription to delete
72 * @param plugin
73 * the Plugin
74 */
75 void delete( int nIdSubscription, Plugin plugin );
76
77 ///////////////////////////////////////////////////////////////////////////
78 // Finders
79
80 /**
81 * Load the data from the table
82 *
83 * @param nKey
84 * The identifier of the subscription
85 * @param plugin
86 * the plugin
87 * @return The instance of the subscription
88 */
89 Subscription load( int nKey, Plugin plugin );
90
91 /**
92 * Load the data of all the subscription objects and returns them as a collection
93 *
94 * @param plugin
95 * the plugin
96 * @return The collection which contains the data of all the subscription objects
97 */
98 Collection<Subscription> selectSubscriptionsList( Plugin plugin );
99
100 /**
101 * Find a list of subscriptions from a filter
102 *
103 * @param filter
104 * The filter
105 * @return The list of subscriptions that matches the given filter
106 */
107 List<Subscription> findByFilter( SubscriptionFilter filter );
108
109 /**
110 * Get max order
111 * @param plugin
112 * @return max order
113 */
114 int getMaxOrder( Plugin plugin );
115
116 }