001/*
002 * (C) Copyright 2006-2011 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 *     Thierry Delprat
018 */
019package org.nuxeo.ecm.core.versioning;
020
021import java.util.List;
022
023import org.nuxeo.ecm.core.api.CoreSession;
024import org.nuxeo.ecm.core.event.impl.ShallowDocumentModel;
025
026/**
027 * Interface to be implemented by contributions to the orphanVersionRemovalFilter extension point.
028 *
029 * @author <a href="mailto:tdelprat@nuxeo.com">Tiry</a>
030 */
031public interface OrphanVersionRemovalFilter {
032
033    /**
034     * This method will be called by the {@link OrphanVersionRemoverListener}. The method should return the
035     * List&lt;String&gt; versionUUIDs that can be deleted.
036     * <p>
037     * A "dummy" implementation will return the same list as the one received as parameter.
038     *
039     * @param session the CoreSession
040     * @param deletedLiveDoc the Shallow DocumentModel that was deleted
041     * @param versionUUIDs the UUIDs of the versions associated to the deleted document
042     * @return the "filtered" list of versions that can be removed
043     */
044    List<String> getRemovableVersionIds(CoreSession session, ShallowDocumentModel deletedLiveDoc,
045            List<String> versionUUIDs);
046}