View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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.util.sql.DAOUtil;
37  
38  import java.util.ArrayList;
39  import java.util.Collection;
40  import java.util.List;
41  
42  
43  /**
44   * This class provides Data Access methods for HistoryEvent objects
45   */
46  public final class HistoryEventDAO implements IHistoryEventDAO
47  {
48      // Constants
49      private static final String SQL_QUERY_INSERT = " INSERT INTO document_history ( id_document, event_date, event_user, event_message_key, document_state_key, document_space ) VALUES ( ?, ?, ?, ?, ?, ? ) ";
50      private static final String SQL_QUERY_DELETE = " DELETE FROM document_history WHERE id_document = ?  ";
51      private static final String SQL_QUERY_SELECT_BY_DOCUMENT = " SELECT id_document, event_date, event_user, event_message_key, document_state_key, document_space FROM document_history WHERE id_document = ? ";
52      private static final String SQL_QUERY_SELECT_BY_USER = " SELECT id_document, event_date, event_user, event_message_key, document_state_key, document_space FROM document_history WHERE event_user = ? ";
53  
54      /**
55       * Insert a new record in the table.
56       *
57       * @param historyEvent The historyEvent object
58       */
59      public void insert( HistoryEvent historyEvent )
60      {
61          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT );
62          daoUtil.setInt( 1, historyEvent.getIdDocument(  ) );
63          daoUtil.setTimestamp( 2, historyEvent.getDate(  ) );
64          daoUtil.setString( 3, historyEvent.getEventUser(  ) );
65          daoUtil.setString( 4, historyEvent.getEventMessageKey(  ) );
66          daoUtil.setString( 5, historyEvent.getDocumentStateKey(  ) );
67          daoUtil.setString( 6, historyEvent.getSpace(  ) );
68  
69          daoUtil.executeUpdate(  );
70          daoUtil.free(  );
71      }
72  
73      /**
74       * Delete a record from the table
75       *
76       * @param nDocumentId The id of the document
77       */
78      public void delete( int nDocumentId )
79      {
80          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE );
81          daoUtil.setInt( 1, nDocumentId );
82  
83          daoUtil.executeUpdate(  );
84          daoUtil.free(  );
85      }
86  
87      /**
88       * Load the list of historyEvents
89       *
90       * @return The Collection of the HistoryEvents
91       * @param nDocumentId The document Id
92       */
93      public List<HistoryEvent> selectEventListByDocument( int nDocumentId )
94      {
95          List<HistoryEvent> listHistoryEvents = new ArrayList<HistoryEvent>(  );
96          DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_BY_DOCUMENT );
97          daoUtil.setInt( 1, nDocumentId );
98          daoUtil.executeQuery(  );
99  
100         while ( daoUtil.next(  ) )
101         {
102             HistoryEventdocument/business/history/HistoryEvent.html#HistoryEvent">HistoryEvent event = new HistoryEvent(  );
103             event.setIdDocument( daoUtil.getInt( 1 ) );
104             event.setDate( daoUtil.getTimestamp( 2 ) );
105             event.setEventUser( daoUtil.getString( 3 ) );
106             event.setEventMessageKey( daoUtil.getString( 4 ) );
107             event.setDocumentStateKey( daoUtil.getString( 5 ) );
108             event.setSpace( daoUtil.getString( 6 ) );
109 
110             listHistoryEvents.add( event );
111         }
112 
113         daoUtil.free(  );
114 
115         return listHistoryEvents;
116     }
117 
118     /**
119      * Load the list of historyEvents
120      *
121      * @return The Collection of the HistoryEvents
122      * @param strUserId The UserId
123      */
124     public Collection<HistoryEvent> selectEventListByUser( String strUserId )
125     {
126         Collection<HistoryEvent> listHistoryEvents = new ArrayList<HistoryEvent>(  );
127         DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_BY_USER );
128         daoUtil.setString( 1, strUserId );
129         daoUtil.executeQuery(  );
130 
131         while ( daoUtil.next(  ) )
132         {
133             HistoryEventdocument/business/history/HistoryEvent.html#HistoryEvent">HistoryEvent event = new HistoryEvent(  );
134             event.setIdDocument( daoUtil.getInt( 1 ) );
135             event.setDate( daoUtil.getTimestamp( 2 ) );
136             event.setEventUser( daoUtil.getString( 3 ) );
137             event.setEventMessageKey( daoUtil.getString( 4 ) );
138             event.setDocumentStateKey( daoUtil.getString( 5 ) );
139             event.setSpace( daoUtil.getString( 6 ) );
140 
141             listHistoryEvents.add( event );
142         }
143 
144         daoUtil.free(  );
145 
146         return listHistoryEvents;
147     }
148 }