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:at@nuxeo.com">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.DirectoryException; 028import org.nuxeo.ecm.directory.api.DirectoryDeleteConstraint; 029 030/** 031 * Interface for directory UI info. 032 * 033 * @author <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a> 034 * @since 5.2.0 GA 035 */ 036public interface DirectoryUI extends Serializable { 037 038 /** 039 * Returns the directory name. 040 */ 041 String getName(); 042 043 /** 044 * Returns the directory view. 045 */ 046 String getView(); 047 048 /** 049 * Returns the directory layout. 050 */ 051 String getLayout(); 052 053 /** 054 * Returns the sort field. 055 */ 056 String getSortField(); 057 058 /** 059 * Returns the readOnly status. 060 */ 061 Boolean isReadOnly(); 062 063 /** 064 * Returns the directory delete constraints 065 * 066 * @see DirectoryDeleteConstraint 067 * @since 5.2.1 068 */ 069 List<DirectoryDeleteConstraint> getDeleteConstraints() throws DirectoryException; 070 071}