1 /**
2 * This file Copyright (c) 2014-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.dam.api;
35
36 import java.util.Iterator;
37
38 /**
39 * A Folder represents a structural item holding {@link Asset}s. Depending on the provider, this can be
40 * directly mapped to the concept of folders/directories (JCR, FileSystems, ...); for others
41 * this might map to the concept of albums, playlists, sets, etc...
42 */
43 public interface Folder extends Item {
44
45 /**
46 * Returns an iterator over the direct elements under this folder; returns both {@link Asset}s and {@link Folder}s.
47 * For more refined results, use {@link AssetProvider#list(AssetQuery)}.
48 */
49 Iterator<Item> getChildren();
50
51 /**
52 * Returns the item directly under this folder with the given name.
53 * TODO @throws AssetNotFoundException if such an item doesn't exist.
54 */
55 Item getItem(String name);
56
57 /**
58 * Returns true if this folder is the root folder of this provider.
59 * Note: some providers might "hide" or show only a subsection of their actual data. This should return true
60 * if and only if this folder is the root of such a subsection.
61 */
62 boolean isRoot();
63 }