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.DocumentModel;
023
024/**
025 * Service handling {@code LocalConfiguration} classes.
026 *
027 * @author <a href="mailto:[email protected]">Thomas Roger</a>
028 * @since 5.4.2
029 */
030public interface LocalConfigurationService {
031
032    /**
033     * Returns the first {@code LocalConfiguration} accessible from the {@code currentDoc}, {@code null} otherwise.
034     * <p>
035     * Find the first parent of the {@code currentDoc} having the given {@code configurationFacet}, if any, and adapt it
036     * on the {@code configurationClass}.
037     */
038    public <T extends LocalConfiguration> T getConfiguration(Class<T> configurationClass, String configurationFacet,
039            DocumentModel currentDoc);
040
041}