View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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.portal.business.mailinglist;
35  
36  import fr.paris.lutece.portal.service.workgroup.WorkgroupRemovalListenerService;
37  
38  import java.util.ArrayList;
39  import java.util.Collection;
40  
41  
42  /**
43   * This class represents a mailing list composed by admin users. All members of those
44   * mailing lists are dynamically retreived by filters based on roles and workgroups.
45   */
46  public class MailingList
47  {
48      private static MailingListWorkgroupRemovalListener _listenerWorkgroup;
49  
50      // Variables declarations
51      private int _nId;
52      private String _strName;
53      private String _strDescription;
54      private String _strWorkgroup;
55      private Collection<MailingListUsersFilter> _listFilters = new ArrayList<MailingListUsersFilter>(  );
56  
57      /**
58       * Initialize the rule
59       */
60      public static synchronized void init(  )
61      {
62          // Create removal listeners and register them
63          if ( _listenerWorkgroup == null )
64          {
65              _listenerWorkgroup = new MailingListWorkgroupRemovalListener(  );
66              WorkgroupRemovalListenerService.getService(  ).registerListener( _listenerWorkgroup );
67          }
68      }
69  
70      /**
71       * Returns the Id
72       *
73       * @return The Id
74       */
75      public int getId(  )
76      {
77          return _nId;
78      }
79  
80      /**
81       * Sets the Id
82       *
83       * @param nId The Id
84       */
85      public void setId( int nId )
86      {
87          _nId = nId;
88      }
89  
90      /**
91       * Returns the Name
92       *
93       * @return The Name
94       */
95      public String getName(  )
96      {
97          return _strName;
98      }
99  
100     /**
101      * Sets the Name
102      *
103      * @param strName The Name
104      */
105     public void setName( String strName )
106     {
107         _strName = strName;
108     }
109 
110     /**
111      * Returns the Description
112      *
113      * @return The Description
114      */
115     public String getDescription(  )
116     {
117         return _strDescription;
118     }
119 
120     /**
121      * Sets the Description
122      *
123      * @param strDescription The Description
124      */
125     public void setDescription( String strDescription )
126     {
127         _strDescription = strDescription;
128     }
129 
130     /**
131      * Returns the Workgroup
132      *
133      * @return The Workgroup
134      */
135     public String getWorkgroup(  )
136     {
137         return _strWorkgroup;
138     }
139 
140     /**
141      * Sets the Workgroup
142      *
143      * @param strWorkgroup The Workgroup
144      */
145     public void setWorkgroup( String strWorkgroup )
146     {
147         _strWorkgroup = strWorkgroup;
148     }
149 
150     /**
151      * Returns filters of the mailing list
152      * @return A collection of users filters
153      */
154     public Collection<MailingListUsersFilter> getFilters(  )
155     {
156         return _listFilters;
157     }
158 }