001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://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: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://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.ade.configuration;
029
030import org.opencms.file.CmsObject;
031
032/**
033 * Interface for plugin classes that provide extra information to be dynamically injected into the sitemap configuration.
034 */
035public interface I_CmsSitemapExtraInfoProvider {
036
037    /**
038     * Gets the information to be injected into the sitemap configuration.
039     *
040     * @param cms an Admin CMS context (does not contain the current request context, but is in the Online/Offline project depending on whether the online/offline sitemap configuration is being evaluated)
041     *
042     * @return the extra information to be injected into the sitemap configuration
043     */
044    I_CmsSitemapExtraInfo getExtraInfo(CmsObject cms);
045
046    /**
047     * Gets the order number.
048     *
049     * <p>Implementations of this interface are used in ascending order, so the ones with higher order can override information from ones with a lower order.
050     *
051     * @return the order number
052     */
053    int getOrder();
054
055}