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.publishing;
35  
36  
37  /**
38   * PublishingEvent
39   */
40  public class PublishingEvent
41  {
42      public static final int DOCUMENT_PUBLISHED = 1;
43      public static final int DOCUMENT_UNPUBLISHED = 2;
44      public static final int DOCUMENT_IS_COMMENT = 3;
45  
46      // Variables declarations
47      private int _nDocumentId;
48      private int _nPortletId;
49      private int _nType;
50  
51      /**
52       * Creates a new instance of PublishingEvent
53       * @param nDocumentId The id of the document
54       * @param nPortletId The id of the portlet
55       * @param nType The type of the event
56       */
57      public PublishingEvent( int nDocumentId, int nPortletId, int nType )
58      {
59          _nDocumentId = nDocumentId;
60          _nPortletId = nPortletId;
61          _nType = nType;
62      }
63  
64      /**
65       * Returns the EventType
66       * @return The EventType
67       */
68      public int getEventType(  )
69      {
70          return _nType;
71      }
72  
73      /**
74       * Returns the Document Id
75       * @return The Document Id
76       */
77      public int getnDocumentId(  )
78      {
79          return _nDocumentId;
80      }
81  
82      /**
83       * Returns the Portlet Id
84       * @return The Portlet Id
85       */
86      public int getPortletId(  )
87      {
88          return _nPortletId;
89      }
90  }