1 /*
2 * Copyright (c) 2002-2023, 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.document.business.history;
35
36 import fr.paris.lutece.portal.service.i18n.I18nService;
37 import fr.paris.lutece.portal.service.spring.SpringContextService;
38
39 import java.util.Collection;
40 import java.util.List;
41 import java.util.Locale;
42
43 /**
44 * This class provides instances management methods (create, find, ...) for HistoryEvent objects
45 */
46 public final class HistoryEventHome
47 {
48 // Static variable pointed at the DAO instance
49 private static IHistoryEventDAO _dao = SpringContextService.getBean( "document.historyEventDAO" );
50
51 /**
52 * Private constructor - this class need not be instantiated
53 */
54 private HistoryEventHome( )
55 {
56 }
57
58 /**
59 * Creation of an instance of historyEvent
60 *
61 * @param historyEvent
62 * The instance of the historyEvent which contains the informations to store
63 * @return The instance of historyEvent which has been created with its primary key.
64 */
65 public static HistoryEvent./../../../../../fr/paris/lutece/plugins/document/business/history/HistoryEvent.html#HistoryEvent">HistoryEvent create( HistoryEvent historyEvent )
66 {
67 _dao.insert( historyEvent );
68
69 return historyEvent;
70 }
71
72 /**
73 * Remove the HistoryEvent whose identifier is specified in parameter
74 *
75 * @param nDocumentId
76 * The document Id
77 */
78 public static void remove( int nDocumentId )
79 {
80 _dao.delete( nDocumentId );
81 }
82
83 ///////////////////////////////////////////////////////////////////////////
84 // Finders
85
86 /**
87 * Returns a collection of historyEvents objects
88 *
89 * @return A collection of historyEvents
90 * @param nDocumentId
91 * The document Id
92 * @param locale
93 * The current locale
94 */
95 public static List<HistoryEvent> findByDocument( int nDocumentId, Locale locale )
96 {
97 List<HistoryEvent> listEvents = _dao.selectEventListByDocument( nDocumentId );
98
99 return I18nService.localizeCollection( listEvents, locale );
100 }
101
102 /**
103 * Returns a collection of historyEvents objects
104 *
105 * @return A collection of historyEvents
106 * @param strUser
107 * The user Id
108 * @param locale
109 * The current locale
110 */
111 public static Collection<HistoryEvent> findByUser( String strUser, Locale locale )
112 {
113 Collection<HistoryEvent> listEvents = _dao.selectEventListByUser( strUser );
114
115 return I18nService.localizeCollection( listEvents, locale );
116 }
117 }