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.file.CmsObject;
031import org.opencms.util.CmsUUID;
032import org.opencms.xml.types.I_CmsXmlContentValue;
033
034/**
035 * Interface representing an XML content location which corresponds to an actual content value.<p>
036 *
037 * @since 8.0.0
038 */
039public interface I_CmsXmlContentValueLocation extends I_CmsXmlContentLocation {
040
041    /**
042     * Returns the structure id of the content value (only valid for VfsFile values!).<p>
043     *
044     * @param cms the CMS context
045     * @return the structure id of the content value
046     */
047    CmsUUID asId(CmsObject cms);
048
049    /**
050     * Returns the string value of the content value.<p>
051     *
052     * @param cms the CMS context
053     *
054     * @return the string value of the content value
055     */
056    String asString(CmsObject cms);
057
058    /**
059     * Returns the content value at the given location.<p>
060     *
061     * @return the content value at the given location
062     */
063    I_CmsXmlContentValue getValue();
064
065}