1 /*
2 * Copyright (c) 2002-2014, 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.calendar.business.portlet;
35
36 import java.util.Date;
37 import java.util.List;
38
39 import fr.paris.lutece.plugins.calendar.service.AgendaResource;
40 import fr.paris.lutece.portal.business.portlet.IPortletInterfaceDAO;
41
42
43 /**
44 * This class provides Data Access methods for CalendarPortlet objects
45 */
46 public interface ICalendarPortletDAO extends IPortletInterfaceDAO
47 {
48 /**
49 * Associates a new agenda to a given portlet.
50 * @param strAgendaId The identifier of the agenda
51 * @param dDateBegin The beginning date
52 * @param dDateEnd The end date
53 * @param nPortletId the identifier of the portlet.
54 */
55 void insertAgendaInterval( int nPortletId, String strAgendaId, String dDateBegin, String dDateEnd );
56
57 /**
58 * De-associate an agenda from a given portlet.
59 * @param strAgendaId The identifier of an agenda resource
60 * @param nPortletId the identifier of the portlet.
61 */
62 void removeAgenda( int nPortletId, String strAgendaId );
63
64 /**
65 * Returns all the agendas associated with a given portlet.
66 * @param nPortletId the identifier of the portlet.
67 * @return a list of unfiltered agenda resources.
68 */
69 List<AgendaResource> findAgendasInPortlet( int nPortletId );
70
71 /**
72 * Finds the agenda which has events between the start and the end date
73 * @param nPortletId The id of the portlet
74 * @param dateBegin The starting date
75 * @param dateEnd The finishing date
76 * @return The agenda
77 */
78 List<AgendaResource> findAgendaBetween( int nPortletId, Date dateBegin, Date dateEnd );
79
80 /**
81 * The beginning date of event display
82 * @param nPortletId The id of the portlet
83 * @return The beginning date
84 */
85 Date getBeginDate( int nPortletId );
86
87 /**
88 * The finishing date of the event display
89 * @param nPortletId The id of the portlet
90 * @return The finishing date
91 */
92 Date getEndDate( int nPortletId );
93
94 /**
95 * Returns the number of following days the event should be displayed
96 * @param nPortletId The id of the portlet
97 * @return The number of days
98 */
99 int getRepetitionDays( int nPortletId );
100
101 /**
102 * Inserts a calendar which will be displayed for the future n days
103 * @param nPortletId The id of the portlet
104 * @param strAgendaId The id of the calendar
105 * @param nDays The number of days the events are displayed
106 */
107 void insertCalendar( int nPortletId, String strAgendaId, int nDays );
108 }