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