1 /** 2 * This file Copyright (c) 2014-2017 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 /** 37 * Features optional implemented/provided by {@link AssetProvider}. Clients can ask a provider if they support 38 * a certain feature before attempting to use it; typically, this would enable/disable certain UI features. 39 * In some cases, this will also indicate that client code can cast to a specific interface. 40 * (e.g. {@link PathAwareAssetProvider} for {@link #hierarchical}) 41 * 42 * If support for write operations is added, this enum will also be extended with new capabilities. 43 */ 44 public enum AssetProviderCapability { 45 /** 46 * Some providers might not have a notion of a hierarchical tree of folders and assets. 47 * This could be used as an indicator for UIs. 48 * @see PathAwareAssetProvider 49 */ 50 hierarchical, 51 52 /** 53 * Whether this provider supports generating renditions of assets. 54 */ 55 rendition, 56 57 /** 58 * Whether this provider supports querying at all. 59 */ 60 query, 61 62 /** 63 * Whether this provider supports querying by keyword. 64 */ 65 queryByKeyword, 66 67 /** 68 * Whether this provider supports pagination. 69 */ 70 queryWithPagination, 71 72 /** 73 * Whether this provider supports sorting in queries. 74 */ 75 queryWithSorting, 76 77 /** 78 * Whether this provider supports queries with an additional provider-specific clauses. 79 * see {@link info.magnolia.dam.api.AssetQuery#getAdditionalQueryStatement()} 80 */ 81 queryWithProviderSpecificString 82 }