001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.acacia.shared;
029
030import com.google.gwt.event.logical.shared.ValueChangeEvent;
031
032/** 
033 * Value change event for entities with an additional field that indicates the type of change. 
034 */
035public class CmsEntityChangeEvent extends ValueChangeEvent<CmsEntity> {
036
037    /** 
038     * Enum indicating the type of changes. 
039     */
040    public enum ChangeType {
041        add, remove, change;
042    }
043
044    private ChangeType m_changeType;
045
046    /** 
047     * Creates a new event instance.
048     * 
049     * @param value the new entity value
050     * @param type the change type 
051     */
052    protected CmsEntityChangeEvent(CmsEntity value, ChangeType type) {
053
054        // TODO Auto-generated constructor stub
055        super(value);
056        m_changeType = type;
057
058    }
059
060    /** 
061     * Gets the change type. 
062     * 
063     * @return the change type 
064     */
065    public ChangeType getChangeType() {
066
067        return m_changeType;
068    }
069
070}