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.participatorybudget.service.campaign.event;
35
36 import fr.paris.lutece.plugins.participatorybudget.business.campaign.Campaign;
37
38 /**
39 * DocumentEvent are sent by CampaignService to notify campaigns changes to listeners.
40 */
41 public class CampaignEvent
42 {
43 public static final String CAMPAIGN_CREATED = "CAMPAIGN_CREATED";
44 public static final String CAMPAIGN_DELETED = "CAMPAIGN_DELETED";
45 public static final String CAMPAIGN_CLONED = "CAMPAIGN_CLONED";
46
47 public static final String CAMPAIGN_CODE_MODIFICATION_AUTHORISATION = "CAMPAIGN_CODE_MODIFICATION_AUTHORISATION"; // Want to modify campaign code
48 public static final String CAMPAIGN_CODE_MODIFIED = "CAMPAIGN_CODE_MODIFIED";
49
50 // Variables declarations
51 private Campaign _mainCampaign;
52 private Campaign _linkedCampaign;
53 private String _strType;
54
55 /**
56 * Creates a new instance of CampaignEvent
57 *
58 * @param mainCampaign
59 * The main campaign (the one the event is about)
60 * @param linkedCampaign
61 * A linked campaign (for example, a cloned one)
62 * @param nType
63 * The type of event
64 */
65 public CampaignEvent( Campaign../../../../../../fr/paris/lutece/plugins/participatorybudget/business/campaign/Campaign.html#Campaign">Campaign mainCampaign, Campaign linkedCampaign, String strType )
66 {
67 _mainCampaign = mainCampaign;
68 _linkedCampaign = linkedCampaign;
69 _strType = strType;
70 }
71
72 /**
73 * Returns the EventType
74 *
75 * @return The EventType
76 */
77 public String getEventType( )
78 {
79 return _strType;
80 }
81
82 /**
83 * Returns the main campaign (the one the event is about)
84 *
85 * @return The main campaign
86 */
87 public Campaign getMainCampaign( )
88 {
89 return _mainCampaign;
90 }
91
92 /**
93 * Returns the linked campaign (for example, a cloned one)
94 *
95 * @return The linked campaign
96 */
97 public Campaign getLinkedCampaign( )
98 {
99 return _linkedCampaign;
100 }
101 }