001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.core.api.model;
023
024import org.nuxeo.ecm.core.api.PropertyException;
025import org.nuxeo.ecm.core.schema.types.Field;
026import org.nuxeo.ecm.core.schema.types.Schema;
027
028/**
029 * A document part is the root of a property tree which is specified by a schema
030 *
031 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
032 * @deprecated since 8.4, use direct {@link Property} getters on {@link org.nuxeo.ecm.core.api.DocumentModel
033 *             DocumentModel} instead
034 * @see org.nuxeo.ecm.core.api.DocumentModel#getPropertyObject
035 * @see org.nuxeo.ecm.core.api.DocumentModel#getPropertyObjects
036 */
037@Deprecated
038public interface DocumentPart extends Property {
039
040    /**
041     * The document schema.
042     *
043     * @return the schema
044     */
045    @Override
046    Schema getSchema();
047
048    Property createProperty(Property parent, Field field);
049
050    Property createProperty(Property parent, Field field, int flags);
051
052    /**
053     * Whether or not to ignore any previous values when setting complex properties.
054     *
055     * @return {@code true} if setting a complex property ignores any previous values
056     * @since 9.3
057     */
058    boolean getClearComplexPropertyBeforeSet();
059
060    //
061    // public void setContextData(String key, Object value);
062    //
063    // public Object getContextData(String key);
064
065}