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:bs@nuxeo.com">Bogdan Stefanescu</a>
032 */
033public interface DocumentPart extends Property {
034
035    /**
036     * The document schema.
037     *
038     * @return the schema
039     */
040    @Override
041    Schema getSchema();
042
043    Property createProperty(Property parent, Field field);
044
045    Property createProperty(Property parent, Field field, int flags);
046
047    PropertyDiff exportDiff() throws PropertyException;
048
049    void importDiff(PropertyDiff diff) throws PropertyException;
050
051    //
052    // public void setContextData(String key, Object value);
053    //
054    // public Object getContextData(String key);
055
056}