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 <ataillefer@nuxeo.com>
018 */
019package org.nuxeo.drive.adapter;
020
021import java.util.List;
022
023import org.codehaus.jackson.annotate.JsonIgnore;
024import org.nuxeo.drive.adapter.impl.DocumentBackedFolderItem;
025import org.nuxeo.ecm.core.api.Blob;
026import org.nuxeo.ecm.core.api.DocumentModel;
027
028/**
029 * Representation of a folder.
030 * <p>
031 * In the case of a {@link DocumentModel} backed implementation, the backing document is Folderish. Typically a Folder
032 * or a Workspace.
033 *
034 * @author Antoine Taillefer
035 * @see DocumentBackedFolderItem
036 */
037public interface FolderItem extends FileSystemItem {
038
039    @JsonIgnore
040    List<FileSystemItem> getChildren();
041
042    boolean getCanCreateChild();
043
044    FileItem createFile(Blob blob);
045
046    FolderItem createFolder(String name);
047
048}