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