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;
031
032import java.util.Collection;
033import java.util.Locale;
034
035/**
036 * Handles changes during the xml content editor session.<p>
037 * Allows to modify the content after certain content fields have been edited. The modifications will then be transfered to the editor.<p>
038 * For example, if the user sets a value for the field /link the change handler may set the value of another field /linktitle to the title of the linked resource.<p>
039 */
040public interface I_CmsXmlContentEditorChangeHandler {
041
042    /**
043     * Returns the handler configuration.<p>
044     *
045     * @return the handler configuration
046     */
047    String getConfiguration();
048
049    /**
050     * Returns the handler scope.<p>
051     *
052     * @return the handler scope
053     */
054    String getScope();
055
056    /**
057     * Handles the content change.<p>
058     *
059     * @param cms the cms context
060     * @param content the changed content
061     * @param locale the edited locale
062     * @param changedPaths the changed content value paths
063     *
064     * @return the changed content
065     */
066    CmsXmlContent handleChange(CmsObject cms, CmsXmlContent content, Locale locale, Collection<String> changedPaths);
067
068    /**
069     * Sets the configuration.<p>
070     *
071     * @param configuration the configuration
072     */
073    void setConfiguration(String configuration);
074
075    /**
076     * Sets the scope to observe for changes.<p>
077     * With a scope set to '/link' all changes below the path /link will be observed.<p>
078     *
079     * @param scope the scope
080     */
081    void setScope(String scope);
082}