001/*
002 * (C) Copyright 2012 Nuxeo SA (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 *     Antoine Taillefer <ataillefer@nuxeo.com>
016 */
017package org.nuxeo.drive.service;
018
019import java.security.Principal;
020
021import org.nuxeo.drive.adapter.FolderItem;
022
023/**
024 * Interface for the classes contributed to the {@code topLevelFolderItemFactory} extension point of the
025 * {@link FileSystemItemAdapterService}.
026 * <p>
027 * Allows to get a virtual {@link FolderItem} for a given user.
028 *
029 * @author Antoine Taillefer
030 * @see XXX
031 */
032public interface VirtualFolderItemFactory extends FileSystemItemFactory {
033
034    /**
035     * Returns the (unique) virtual {@link FolderItem}.
036     */
037    FolderItem getVirtualFolderItem(Principal principal);
038
039    String getFolderName();
040
041    void setFolderName(String folderName);
042
043}