View Javadoc
1   /*
2    * Copyright (c) 2002-2022, 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.portal.service.util;
35  
36  import java.util.ArrayList;
37  import java.util.List;
38  import java.util.Locale;
39  
40  /**
41   * RemovalListenerService
42   */
43  public class RemovalListenerService
44  {
45      private List<RemovalListener> _listRegisteredListeners = new ArrayList<>( );
46  
47      /**
48       * Register a new Removal listener
49       * 
50       * @param listener
51       *            The listener to register
52       */
53      public void registerListener( RemovalListener listener )
54      {
55          _listRegisteredListeners.add( listener );
56      }
57  
58      /**
59       * Check if an object can be remove
60       * 
61       * @param strIdToRemove
62       *            The object ID
63       * @param listMessages
64       *            Messages if some listeners have refused the removal
65       * @param locale
66       *            The current locale
67       * @return true if the object can be removed otherwise false
68       */
69      public boolean checkForRemoval( String strIdToRemove, List<String> listMessages, Locale locale )
70      {
71          boolean bCheck = true;
72  
73          for ( RemovalListener listener : _listRegisteredListeners )
74          {
75              if ( !listener.canBeRemoved( strIdToRemove ) )
76              {
77                  listMessages.add( listener.getRemovalRefusedMessage( strIdToRemove, locale ) );
78                  bCheck = false;
79              }
80          }
81  
82          return bCheck;
83      }
84  }