001/*
002 * (C) Copyright 2009 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 *     Anahide Tchertchian
018 */
019package org.nuxeo.ecm.directory.api.ui;
020
021import java.io.Serializable;
022import java.util.Map;
023
024import org.nuxeo.ecm.directory.DirectoryException;
025import org.nuxeo.ecm.directory.api.DirectoryService;
026
027/**
028 * Interface for delete constraint on a directory, dependent to another directory.
029 *
030 * @author Anahide Tchertchian
031 */
032public interface DirectoryUIDeleteConstraint extends Serializable {
033
034    /**
035     * Sets properties that may depend on the directory configuration.
036     */
037    void setProperties(Map<String, String> properties) throws DirectoryException;
038
039    /**
040     * Returns true if given entry can be deleted from the directory where constraint is declared.
041     *
042     * @param dirService the directory service
043     * @param entryId the entry to delete id
044     * @throws DirectoryException
045     */
046    boolean canDelete(DirectoryService dirService, String entryId) throws DirectoryException;
047
048}