org.opencms.xml.content.I_CmsXmlContentEditorChangeHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.xml.content;

import org.opencms.file.CmsObject;

import java.util.Collection;
import java.util.Locale;

/**
 * Handles changes during the xml content editor session.
 * Allows to modify the content after certain content fields have been edited. The modifications will then be transfered to the editor.

 * 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.

 */
public interface I_CmsXmlContentEditorChangeHandler {

    /**
     * Returns the handler configuration.

     *
     * @return the handler configuration
     */
    String getConfiguration();

    /**
     * Returns the handler scope.

     *
     * @return the handler scope
     */
    String getScope();

    /**
     * Handles the content change.

     *
     * @param cms the cms context
     * @param content the changed content
     * @param locale the edited locale
     * @param changedPaths the changed content value paths
     *
     * @return the changed content
     */
    CmsXmlContent handleChange(CmsObject cms, CmsXmlContent content, Locale locale, Collection changedPaths);

    /**
     * Sets the configuration.

     *
     * @param configuration the configuration
     */
    void setConfiguration(String configuration);

    /**
     * Sets the scope to observe for changes.

     * With a scope set to '/link' all changes below the path /link will be observed.
     *
     * @param scope the scope
     */
    void setScope(String scope);
}