001/*
002 * (C) Copyright 2010 Nuxeo SAS (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 * Contributors:
014 * Nuxeo - initial API and implementation
015 */
016
017package org.nuxeo.ecm.platform.types.localconfiguration;
018
019import java.util.List;
020import java.util.Map;
021
022import org.nuxeo.ecm.core.api.localconfiguration.LocalConfiguration;
023import org.nuxeo.ecm.platform.types.SubType;
024
025/**
026 * Local configuration class to handle configuration of UI Types.
027 *
028 * @author <a href="mailto:troger@nuxeo.com">Thomas Roger</a>
029 */
030public interface UITypesConfiguration extends LocalConfiguration<UITypesConfiguration> {
031
032    /**
033     * Returns the configured allowed types.
034     */
035    List<String> getAllowedTypes();
036
037    /**
038     * Returns the configured denied types.
039     */
040    List<String> getDeniedTypes();
041
042    /**
043     * Returns {@code true} if all the types are denied, {@code false} otherwise.
044     */
045    boolean denyAllTypes();
046
047    /**
048     * Filter the {@code allowedSubTypes} according to this object configuration.
049     */
050    Map<String, SubType> filterSubTypes(Map<String, SubType> allowedSubTypes);
051
052    String getDefaultType();
053}