001/*
002 * (C) Copyright 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 *     Nuxeo - initial API and implementation
016 *
017 * $Id: DirectoryTreeManager.java 28950 2008-01-11 13:35:06Z tdelprat $
018 */
019package org.nuxeo.ecm.webapp.directory;
020
021import java.io.Serializable;
022import java.util.List;
023
024public interface DirectoryTreeManager extends Serializable {
025
026    DirectoryTreeNode get(String treeName);
027
028    DirectoryTreeNode getSelectedTree();
029
030    List<DirectoryTreeNode> getDirectoryTrees();
031
032    List<String> getDirectoryTreeNames();
033
034    String getSelectedTreeName();
035
036    void setSelectedTreeName(String treeName);
037
038    boolean isInitialized();
039
040    /**
041     * Returns the internationalized label for a given path of the specified Directory tree. The Directory tree label is
042     * not included.
043     *
044     * @since 5.4
045     */
046    public String getLabelFor(String directoryTreeName, String fullPath);
047
048    /**
049     * Returns the internationalized label for a given path of the specified Directory tree, including or not the
050     * Directory tree label.
051     *
052     * @since 5.4
053     */
054    public String getLabelFor(String directoryTreeName, String fullPath, boolean includeDirectoryTreeLabel);
055
056}