001/*
002 *  Copyright 2015 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.plugins.contentstree;
017
018import java.util.Set;
019
020/**
021 * This interface describe the configuration for a contents tree.
022 */
023public interface TreeConfiguration
024{
025    /**
026     * Get the extension unique id
027     * @return The extension id
028     */
029    public String getId();
030    
031    /**
032     * Get the tool role for the UI tool factory
033     * @return The js role
034     */
035    public String getUIToolRole();    
036    
037    /**
038     * Get the elements to build the tree
039     * @return The elements. Can not be null.
040     */
041    public Set<TreeConfigurationElements> getElements();
042}