001/*
002 * (C) Copyright 2006-2007 Nuxeo SAS (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 *     <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
016 *
017 * $Id: WidgetType.java 26053 2007-10-16 01:45:43Z atchertchian $
018 */
019
020package org.nuxeo.ecm.platform.forms.layout.api;
021
022import java.io.Serializable;
023import java.util.List;
024import java.util.Map;
025
026/**
027 * Interface for widget type.
028 * <p>
029 * A widget type is used to handle the rendering of a widget in a given mode.
030 *
031 * @author <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
032 */
033public interface WidgetType extends Serializable {
034
035    /**
036     * Returns the name of this widget type, used to identify it in the service.
037     */
038    String getName();
039
040    /**
041     * Return alias names for this widget type (useful for compatibility on old widget types).
042     *
043     * @since 6.0
044     */
045    List<String> getAliases();
046
047    /**
048     * Returns the class defining this widget type behaviour.
049     */
050    Class<?> getWidgetTypeClass();
051
052    /**
053     * Returns properties.
054     */
055    Map<String, String> getProperties();
056
057}