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 java.io.IOException;
022import java.io.Writer;
023
024/**
025 * A notification (as defined by the JSON RPC specification) to be sent to
026 * the portlet view (the browser).
027 */
028public class DeletePortlet extends PortalCommand {
029
030    private final String portletId;
031
032    /**
033     * Creates a new event.
034     *  
035     * @param portletId the portlet (view) that should be deleted
036     */
037    public DeletePortlet(String portletId) {
038        this.portletId = portletId;
039    }
040
041    /**
042     * Returns the portlet id.
043     * 
044     * @return the portlet id
045     */
046    public String portletId() {
047        return portletId;
048    }
049
050    @Override
051    public void toJson(Writer writer) throws IOException {
052        toJson(writer, "deletePortlet", portletId());
053    }
054
055}