RemovalListenerService.java

/*
 * Copyright (c) 2002-2016, Mairie de Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.portal.service.util;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

/**
 * RemovalListenerService
 */
public class RemovalListenerService
{
    private List<RemovalListener> _listRegisteredListeners = new ArrayList<RemovalListener>( );

    /**
     * Register a new Removal listener
     * 
     * @param listener
     *            The listener to register
     */
    public void registerListener( RemovalListener listener )
    {
        _listRegisteredListeners.add( listener );
    }

    /**
     * Check if an object can be remove
     * 
     * @param strIdToRemove
     *            The object ID
     * @param listMessages
     *            Messages if some listeners have refused the removal
     * @param locale
     *            The current locale
     * @return true if the object can be removed otherwise false
     */
    public boolean checkForRemoval( String strIdToRemove, List<String> listMessages, Locale locale )
    {
        boolean bCheck = true;

        for ( RemovalListener listener : _listRegisteredListeners )
        {
            if ( !listener.canBeRemoved( strIdToRemove ) )
            {
                listMessages.add( listener.getRemovalRefusedMessage( strIdToRemove, locale ) );
                bCheck = false;
            }
        }

        return bCheck;
    }
}