001/*
002 * (C) Copyright 2012 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 *     Antoine Taillefer
018 */
019package org.nuxeo.ecm.diff.service;
020
021import java.io.Serializable;
022import java.util.List;
023import java.util.Map;
024
025import org.nuxeo.ecm.core.api.DocumentModel;
026import org.nuxeo.ecm.diff.model.DiffBlockDefinition;
027import org.nuxeo.ecm.diff.model.DiffComplexFieldDefinition;
028import org.nuxeo.ecm.diff.model.DiffDisplayBlock;
029import org.nuxeo.ecm.diff.model.DocumentDiff;
030
031/**
032 * Handles the configuration of a document diff display.
033 *
034 * @author Antoine Taillefer (ataillefer@nuxeo.com)
035 * @since 5.6
036 */
037public interface DiffDisplayService extends Serializable {
038
039    Map<String, List<String>> getDiffExcludedSchemas();
040
041    List<String> getDiffExcludedFields(String schemaName);
042
043    List<DiffComplexFieldDefinition> getDiffComplexFields();
044
045    DiffComplexFieldDefinition getDiffComplexField(String schemaName, String fieldName);
046
047    Map<String, List<String>> getDiffDisplays();
048
049    List<String> getDiffDisplay(String docType);
050
051    Map<String, DiffBlockDefinition> getDiffBlockDefinitions();
052
053    DiffBlockDefinition getDiffBlockDefinition(String name);
054
055    List<DiffDisplayBlock> getDiffDisplayBlocks(DocumentDiff docDiff, DocumentModel leftDoc, DocumentModel rightDoc);
056
057}