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 GmbH & Co. KG, 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.jsp;
029
030import org.opencms.xml.I_CmsXmlDocument;
031
032import java.util.Locale;
033
034/**
035 * Provides access to a <code>{@link org.opencms.xml.I_CmsXmlDocument}</code> document that was previously loaded by a parent tag.<p>
036 *
037 * @since 6.2.0
038 */
039public interface I_CmsXmlContentContainer extends I_CmsResourceContainer {
040
041    /**
042     * Returns the currently loaded OpenCms XML content document.<p>
043     *
044     * @return the currently loaded OpenCms XML content document
045     */
046    I_CmsXmlDocument getXmlDocument();
047
048    /**
049     * Returns the currently selected element name in the loaded XML content document.<p>
050     *
051     * @return the currently selected element name in the loaded XML content document
052     */
053    String getXmlDocumentElement();
054
055    /**
056     * Returns the currently selected locale used for acessing the content in the loaded XML content document.<p>
057     *
058     * @return the currently selected locale used for acessing the content in the loaded XML content document
059     */
060    Locale getXmlDocumentLocale();
061}