001/*
002 * (C) Copyright 2006-2008 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 *
014 * Contributors:
015 *     <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
016 *
017 * $Id:  $
018 */
019
020package org.nuxeo.ecm.directory.api.ui;
021
022import java.io.Serializable;
023import java.util.List;
024
025import org.nuxeo.ecm.directory.DirectoryException;
026
027/**
028 * Interface for directory UI info.
029 *
030 * @author <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
031 * @since 5.2.0 GA
032 */
033public interface DirectoryUI extends Serializable {
034
035    /**
036     * Returns the directory name.
037     */
038    String getName();
039
040    /**
041     * Returns the directory view.
042     */
043    String getView();
044
045    /**
046     * Returns the directory layout.
047     */
048    String getLayout();
049
050    /**
051     * Returns the sort field.
052     */
053    String getSortField();
054
055    /**
056     * Returns the readOnly status.
057     */
058    Boolean isReadOnly();
059
060    /**
061     * Returns the directory delete constraints
062     *
063     * @see DirectoryUIDeleteConstraint
064     * @since 5.2.1
065     */
066    List<DirectoryUIDeleteConstraint> getDeleteConstraints() throws DirectoryException;
067
068}