001/*
002 *  Copyright 2018 Anyware Services
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 */
016package org.ametys.runtime.model;
017
018/**
019 * Interface for view references to model items
020 * @param <T> type of the referenced model item
021 */
022public interface ModelViewItem<T extends ModelItem> extends ViewItem
023{
024    /** The default tag name to use while generating SAX events */
025    public static final String DEFAULT_ITEM_TAG_NAME = "item";
026    
027    /**
028     * Determine the rendering of the item when it is disabled
029     */
030    public enum DisabledItemRendering
031    {
032        /** Keep default rendering, defined by form or other algorithm */
033        DEFAULT,
034        /** Force to disable the item, even if it should be hidden by default */
035        DISABLED,
036        /** Force to hide the item, even if it should be disabled by default */
037        HIDDEN
038    }
039    
040    /**
041     * Retrieves the referenced model item definition
042     * @return the referenced definition
043     */
044    public T getDefinition();
045    
046    /**
047     * Sets the referenced model item definition
048     * @param definition the referenced definition
049     */
050    public void setDefinition(T definition);
051    
052    /**
053     * Retrieves the rendering of the view item when it is disabled
054     * @return the rendering of the view item when it is disabled
055     */
056    public DisabledItemRendering getDisabledItemRendering();
057    
058    /**
059     * Sets the rendering of the view item when it is disabled
060     * @param disabledItemRendering the rendering to set
061     */
062    public void setDisabledItemRendering(DisabledItemRendering disabledItemRendering);
063    
064    default String getName()
065    {
066        T definition = getDefinition();
067        return definition != null ? definition.getName() : null;
068    }
069    
070    default void setName(String name)
071    {
072        throw new UnsupportedOperationException("Cannot set name for a ModelViewItem");
073    }
074}