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 * Nuxeo - initial API and implementation
018 */
019
020package org.nuxeo.ecm.core.api.localconfiguration;
021
022import org.nuxeo.ecm.core.api.CoreSession;
023import org.nuxeo.ecm.core.api.DetachedAdapter;
024import org.nuxeo.ecm.core.api.DocumentRef;
025
026/**
027 * Interface that must be implemented by other interface representing a local configuration.
028 *
029 * @author <a href="mailto:troger@nuxeo.com">Thomas Roger</a>
030 * @since 5.4.2
031 */
032public interface LocalConfiguration<T> extends DetachedAdapter {
033
034    /**
035     * Returns the related {@code DocumentRef} of this local configuration.
036     */
037    DocumentRef getDocumentRef();
038
039    /**
040     * Returns {@code true} if this {@code LocalConfiguration} accepted to be merged with a parent configuration,
041     * {@code false} otherwise.
042     */
043    boolean canMerge();
044
045    /**
046     * Merge this {@code LocalConfiguration} with another one.
047     */
048    T merge(T other);
049
050    /**
051     * Save this LocalConfiguration.
052     *
053     * @since 5.5
054     */
055    void save(CoreSession session);
056
057}