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.whatsnew.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.sql.Timestamp;
39
40 import java.util.Collection;
41 import java.util.List;
42 import java.util.Locale;
43
44
45 /**
46 *
47 * IWhatsNewDAO
48 *
49 */
50 public interface IWhatsNewDAO
51 {
52 /**
53 * Returns the list of the pages which correspond to the criteria given
54 * @param dateLimit the timestamp giving the beginning of the period to watch
55 * @param locale {@link Locale}
56 * @return the list in form of a Collection object
57 */
58 Collection<IWhatsNew> selectPagesByCriterias( Timestamp dateLimit, Locale locale );
59
60 /**
61 * Returns the list of the portlets which correspond to the criteria given
62 * @param dateLimit the timestamp giving the beginning of the period to watch
63 * @param locale {@link Locale}
64 * @return the list in form of a Collection object
65 */
66 Collection<IWhatsNew> selectPortletsByCriterias( Timestamp dateLimit, Locale locale );
67
68 /**
69 * Returns the list of the documents which correspond to the criteria given
70 * @param dateLimit the timestamp giving the beginning of the period to watch
71 * @param plugin {@link Plugin}
72 * @param locale {@link Locale}
73 * @return the list in form of a Collection object
74 */
75 Collection<IWhatsNew> selectDocumentsByCriterias( Timestamp dateLimit, Plugin plugin, Locale locale );
76
77 /**
78 * Returns the list of pages which correspond to the list of page IDs
79 * @param listPageIds the list of page IDs
80 * @param locale {@link Locale}
81 * @return a collection of {@link IWhatsNew}
82 */
83 Collection<IWhatsNew> selectPages( List<Integer> listPageIds, Locale locale );
84
85 /**
86 * Returns the list of portlets which correspond to the list of page IDs
87 * @param listPortletIds the list of portlets IDs
88 * @param locale {@link Locale}
89 * @return a collection of {@link IWhatsNew}
90 */
91 Collection<IWhatsNew> selectPortlets( List<Integer> listPortletIds, Locale locale );
92
93 /**
94 * Returns the list of documents which correspond to the list of page IDs
95 * @param listPortletDocumentLinks the list of page IDs
96 * @param locale {@link Locale}
97 * @return a collection of {@link IWhatsNew}
98 */
99 Collection<IWhatsNew> selectDocuments( List<PortletDocumentLink> listPortletDocumentLinks, Locale locale );
100
101 /**
102 * Check if the given page is out of date
103 * @param nPageId the page ID
104 * @param dateLimit the date limit
105 * @return true if it is out of date, false otherwise
106 */
107 boolean isPageOutOfDate( int nPageId, Timestamp dateLimit );
108
109 /**
110 * Check if the given portlet is out of date
111 * @param nPortletId the portlet ID
112 * @param dateLimit the date limit
113 * @return true if it is out of date, false otherwise
114 */
115 boolean isPortletOutOfDate( int nPortletId, Timestamp dateLimit );
116
117 /**
118 * Check if the given document is out of date
119 * @param pdLink {@link PortletDocumentLink}
120 * @param dateLimit the date limit
121 * @param plugin {@link Plugin}
122 * @return true if it is out of date, false otherwise
123 */
124 boolean isDocumentOutOfDate( PortletDocumentLink pdLink, Timestamp dateLimit, Plugin plugin );
125 }