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