View Javadoc
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.newsletter.business.portlet;
35  
36  import fr.paris.lutece.portal.business.portlet.IPortletInterfaceDAO;
37  import fr.paris.lutece.portal.service.plugin.Plugin;
38  
39  import java.util.ArrayList;
40  
41  /**
42   * This class provides Data Access methods for NewsLetterArchivePortlet objects
43   */
44  public interface INewsLetterArchivePortletDAO extends IPortletInterfaceDAO
45  {
46      /**
47       * Associates a new sending to a given portlet.
48       * 
49       * @param nPortletId
50       *            the identifier of the portlet.
51       * @param nSendingId
52       *            the identifier of the sending.
53       * @param plugin
54       *            the plugin
55       */
56      void insertSending( int nPortletId, int nSendingId, Plugin plugin );
57  
58      /**
59       * De-associate a sending from a given portlet.
60       * 
61       * @param nPortletId
62       *            the identifier of the portlet.
63       * @param plugin
64       *            the plugin
65       * @param nSendingId
66       *            the identifier of the sending.
67       */
68      void removeSending( int nPortletId, int nSendingId, Plugin plugin );
69  
70      /**
71       * Returns all the sendings associated with a given portlet.
72       * 
73       * @param nPortletId
74       *            the identifier of the portlet.
75       * @param plugin
76       *            the plugin
77       * @return a Set of Integer objects containing the identifers of the sendings.
78       */
79      ArrayList<Integer> findSendingsInPortlet( int nPortletId, Plugin plugin );
80  }