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.widgets;
029
030import org.opencms.file.CmsObject;
031import org.opencms.i18n.CmsMessages;
032
033/**
034 * Enables a dynamic configuration of values for the {@link A_CmsGalleryWidget}.<p>
035 *
036 * The following values can be configured dynamically:
037 * <ul>
038 * <li>The type of the preselected item list (gallery or category)</li>
039 * <li>The preselected item list (i.e. a gallery folder or category)</li>
040 * </ul>
041 *
042 * @since 7.5.0
043 */
044
045public interface I_CmsGalleryWidgetDynamicConfiguration {
046
047    /**
048     * Returns the required information for the initial item list to load.<p>
049     *
050     * If a gallery should be shown, the path to the gallery must be specified,
051     * for a category the category path.<p>
052     *
053     * @param cms an initialized instance of a CmsObject
054     * @param widgetDialog the dialog where the widget is used on
055     * @param param the widget parameter to generate the widget for
056     * @return the required information for the initial item list to load
057     */
058    String getStartup(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param);
059
060    /**
061     * Returns the type of the initial item list to load, either gallery or category.<p>
062     *
063     * @param cms an initialized instance of a CmsObject
064     * @param widgetDialog the dialog where the widget is used on
065     * @param param the widget parameter to generate the widget for
066     * @return the type of the initial image list to load, either gallery or category
067     */
068    String getType(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param);
069}