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.xml.content;
029
030import org.opencms.xml.I_CmsXmlDocument;
031
032import java.util.List;
033import java.util.Locale;
034
035/**
036 * This class represents a location in an XML content for a specific locale.<p>
037 *
038 * It is used for conveniently retrieving configuration values from an XML content without manually
039 * concatenating xpath strings.<p>
040 *
041 * @since 8.0.0
042 *
043 */
044public interface I_CmsXmlContentLocation {
045
046    /**
047     * Returns the XML document.<p>
048     *
049     * @return the XML document
050     */
051    I_CmsXmlDocument getDocument();
052
053    /**
054     * Returns the locale.<p>
055     *
056     * @return the locale
057     */
058    Locale getLocale();
059
060    /**
061     * Returns the location for an xpath relative to the current location.<p>
062     *
063     * @param subPath the relative path
064     * @return the location which the relative path points to
065     */
066    I_CmsXmlContentValueLocation getSubValue(String subPath);
067
068    /**
069     * Returns the locations for an xpath relative to the current location.<p>
070     *
071     * @param subPath the relative path
072     * @return the locations which the relative path points to
073     */
074    List<I_CmsXmlContentValueLocation> getSubValues(String subPath);
075
076}