DirectoryDeleteConstraint.java

/*
 * (C) Copyright 2009 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Contributors:
 *     Anahide Tchertchian
 */
package org.nuxeo.ecm.directory.api;

import java.io.Serializable;
import java.util.Map;

import org.nuxeo.ecm.directory.DirectoryException;

/**
 * Interface for delete constraint on a directory, dependent to another directory.
 *
 * @author Anahide Tchertchian
 */
public interface DirectoryDeleteConstraint extends Serializable {

    /**
     * Sets properties that may depend on the directory configuration.
     */
    void setProperties(Map<String, String> properties) throws DirectoryException;

    /**
     * Returns true if given entry can be deleted from the directory where constraint is declared.
     *
     * @param dirService the directory service
     * @param entryId the entry to delete id
     * @throws DirectoryException
     */
    boolean canDelete(DirectoryService dirService, String entryId) throws DirectoryException;

}