001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2017-2018 Michael N. Lipp
004 * 
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Affero General Public License as published by 
007 * the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 * 
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Affero General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jgrapes.portal.base.events;
020
021import org.jgrapes.core.Event;
022import org.jgrapes.portal.base.RenderSupport;
023
024/**
025 * A request to delete a portlet instance.
026 */
027public class DeletePortletRequest extends Event<Void> {
028
029    private final RenderSupport renderSupport;
030    private final String portletId;
031
032    /**
033     * Creates a new event.
034     * 
035     * @param renderSupport the render support from the portal in case
036     * the response requires it
037     * @param portletId the portlet model that the notification is 
038     * directed at 
039     */
040    public DeletePortletRequest(RenderSupport renderSupport,
041            String portletId) {
042        this.renderSupport = renderSupport;
043        this.portletId = portletId;
044    }
045
046    /**
047     * Returns the render support.
048     * 
049     * @return the render support
050     */
051    public RenderSupport renderSupport() {
052        return renderSupport;
053    }
054
055    /**
056     * Returns the portlet id.
057     * 
058     * @return the portlet id
059     */
060    public String portletId() {
061        return portletId;
062    }
063
064}