001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (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.cmis;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.main.CmsException;
033
034/**
035 * Interface for dynamic CMIS properties.<p>
036 *
037 * Dynamic properties don't actually exist in the VFS, instead they are read and written by calling
038 * methods on the subclasses implementing this interface which have been configured in the repository configuration.<p>
039 *
040 */
041public interface I_CmsPropertyProvider {
042
043    /**
044     * Returns the name of the dynamic property.<p>
045     *
046     * The id of the property will consist of the name combined with an opencms-dynamic: prefix.<p>
047     *
048     * @return the name of the property
049     */
050    String getName();
051
052    /**
053     * Reads the property value.<p>
054     *
055     * @param cms the current CMS context
056     * @param resource the resource for which the property should be read
057     *
058     * @return the property value
059     *
060     * @throws CmsException if something goes wrong
061     */
062    String getPropertyValue(CmsObject cms, CmsResource resource) throws CmsException;
063
064    /**
065     * Returns true if this dynamic property is writable.<p>
066     *
067     * @return true if the property is writable
068     */
069    boolean isWritable();
070
071    /**
072     * Writes the property value.<p>
073     *
074     * @param cms the current CMS context.<p>
075     *
076     * @param resource the resource for which to write the property
077     * @param valueToSet the value to write
078     *
079     * @throws CmsException if something goes wrong
080     */
081    void setPropertyValue(CmsObject cms, CmsResource resource, String valueToSet) throws CmsException;
082}