001/*
002 *  Copyright 2014 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.explorer;
017
018import org.ametys.plugins.repository.AmetysObject;
019import org.ametys.plugins.repository.AmetysRepositoryException;
020
021/**
022 * {@link AmetysObject} composing the resources tree of the resources explorer.
023 */
024public interface ExplorerNode extends AmetysObject
025{
026    /**
027     * Returns the icon css class for this Node.
028     * @return the icon css class for this Node
029     * for rendering in the tree.
030     */
031    public String getIconCls();
032    
033    /**
034     * Returns the application id corresponding to this Node.
035     * @return the application id corresponding to this Node.
036     */
037    public String getApplicationId();
038    
039    /**
040     * Returns the path of this explorer node in the explorer hierarchy (which is a subset of the whole repository).<br>
041     * If this collection is the root explorer node, "" is returned.
042     * @return the path of this node in its hierarchy.
043     * @throws AmetysRepositoryException if an error occurs.
044     */
045    public String getExplorerPath();
046    
047    /**
048     * Returns true if this explorer node contains child explorer nodes.
049     * @return true if this explorer node contains child explorer nodes.
050     * @throws AmetysRepositoryException if an error occurs.
051     */
052    public boolean hasChildExplorerNodes() throws AmetysRepositoryException;
053    
054    /**
055     * Get the description of the application
056     * @return the description
057     */
058    public String getDescription();
059}