001/*
002 * (C) Copyright 2012 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Antoine Taillefer
016 */
017package org.nuxeo.ecm.diff.service;
018
019import java.io.Serializable;
020import java.util.List;
021import java.util.Map;
022
023import org.nuxeo.ecm.core.api.DocumentModel;
024import org.nuxeo.ecm.diff.model.DiffBlockDefinition;
025import org.nuxeo.ecm.diff.model.DiffComplexFieldDefinition;
026import org.nuxeo.ecm.diff.model.DiffDisplayBlock;
027import org.nuxeo.ecm.diff.model.DocumentDiff;
028
029/**
030 * Handles the configuration of a document diff display.
031 *
032 * @author Antoine Taillefer (ataillefer@nuxeo.com)
033 * @since 5.6
034 */
035public interface DiffDisplayService extends Serializable {
036
037    Map<String, List<String>> getDiffExcludedSchemas();
038
039    List<String> getDiffExcludedFields(String schemaName);
040
041    List<DiffComplexFieldDefinition> getDiffComplexFields();
042
043    DiffComplexFieldDefinition getDiffComplexField(String schemaName, String fieldName);
044
045    Map<String, List<String>> getDiffDisplays();
046
047    List<String> getDiffDisplay(String docType);
048
049    Map<String, DiffBlockDefinition> getDiffBlockDefinitions();
050
051    DiffBlockDefinition getDiffBlockDefinition(String name);
052
053    List<DiffDisplayBlock> getDiffDisplayBlocks(DocumentDiff docDiff, DocumentModel leftDoc, DocumentModel rightDoc);
054
055}