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.service;
35  
36  import fr.paris.lutece.plugins.document.business.Document;
37  import fr.paris.lutece.portal.business.user.AdminUser;
38  
39  
40  /**
41   * DocumentEvent are sent by DocumentService to notify documents changes to
42   * listeners.
43   */
44  public class DocumentEvent
45  {
46      public static final int DOCUMENT_CREATED = 1;
47      public static final int DOCUMENT_CONTENT_MODIFIED = 2;
48      public static final int DOCUMENT_STATE_CHANGED = 3;
49      public static final int DOCUMENT_MOVED = 4;
50  
51      // Variables declarations
52      private Document _document;
53      private AdminUser _user;
54      private int _nType;
55      private int _nSpaceId;
56      private int _nStateId;
57  
58      /**
59       * Creates a new instance of DocumentEvent
60       * @param document The document
61       * @param user The user
62       * @param nType The type of event
63       */
64      public DocumentEvent( Document document, AdminUser user, int nType )
65      {
66          _document = document;
67          _user = user;
68          _nType = nType;
69          _nSpaceId = _document.getSpaceId(  );
70          _nStateId = _document.getStateId(  );
71      }
72  
73      /**
74       * Returns the EventType
75       *
76       * @return The EventType
77       */
78      public int getEventType(  )
79      {
80          return _nType;
81      }
82  
83      /**
84       * Returns the Document
85       *
86       * @return The Document
87       */
88      public Document getDocument(  )
89      {
90          return _document;
91      }
92  
93      /**
94       * Returns the User
95       *
96       * @return The User
97       */
98      public AdminUser getUser(  )
99      {
100         return _user;
101     }
102 
103     /**
104      * Returns the space id of the document before any rule has been applied
105      *
106      * @return the space id
107      */
108     public int getSpaceId(  )
109     {
110         return _nSpaceId;
111     }
112 
113     /**
114      * Returns the state id of the document before any rule has been applied
115      *
116      * @return the state id
117      */
118     public int getStateId(  )
119     {
120         return _nStateId;
121     }
122 }