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