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.ui.actions.prefillpage;
029
030import org.opencms.ui.I_CmsDialogContext;
031
032/**
033 * Interface for prefill page handlers, callable via the context menu action {@link org.opencms.ui.actions.CmsPrefillPageAction}.
034 * A handler is configured via the sitemap attribute "template.prefill.handler".
035 */
036public interface I_CmsPrefillPageHandler {
037
038    /**
039     * Execute the prefill action.
040     * It is assumed that{@link I_CmsPrefillPageHandler#isExecutable(I_CmsDialogContext)} has yielded true for the provided context.
041     *
042     * @param context the context in which the action is performed.
043     */
044    void execute(I_CmsDialogContext context);
045
046    /**
047     * Checks if the action is executable in the provided context.
048     * It already is checked, that we are in the page editor and have only one resource in the context (the containerpage).
049     * @param context the context in which the action shall be performed.
050     * @return <code>true</code> iff the action is executable in the provided context.
051     */
052    boolean isExecutable(I_CmsDialogContext context);
053}