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.model;
018
019import java.io.Serializable;
020import java.util.List;
021
022/**
023 * Diff field definition interface.
024 *
025 * @author <a href="mailto:ataillefer@nuxeo.com">Antoine Taillefer</a>
026 * @since 5.6
027 */
028public interface DiffFieldDefinition extends Serializable {
029
030    /**
031     * Optional category on the field: if this category is filled, the widget instance will be looked up with this
032     * category in the store
033     */
034    String getCategory();
035
036    /**
037     * Gets the field schema.
038     *
039     * @return the field schema
040     */
041    String getSchema();
042
043    /**
044     * Gets the field name.
045     *
046     * @return the field name
047     */
048    String getName();
049
050    /**
051     * Checks if must display content diff links.
052     *
053     * @return true, if must display content diff links
054     */
055    boolean isDisplayContentDiffLinks();
056
057    /**
058     * Gets the field items.
059     *
060     * @return the field items
061     */
062    List<DiffFieldItemDefinition> getItems();
063
064}