OrphanVersionRemovalFilter.java

/*
 * (C) Copyright 2006-2011 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:
 *     Thierry Delprat
 */
package org.nuxeo.ecm.core.versioning;

import java.util.List;

import org.nuxeo.ecm.core.api.CoreSession;
import org.nuxeo.ecm.core.event.impl.ShallowDocumentModel;

/**
 * Interface to be implemented by contributions to the orphanVersionRemovalFilter extension point.
 * 
 * @author <a href="mailto:tdelprat@nuxeo.com">Tiry</a>
 */
public interface OrphanVersionRemovalFilter {

    /**
     * This method will be called by the {@link OrphanVersionRemoverListener}. The method should return the List<String>
     * versionUUIDs that can be deleted.
     * <p>
     * A "dummy" implementation will return the same list as the one received as parameter.
     * 
     * @param session the CoreSession
     * @param deletedLiveDoc the Shallow DocumentModel that was deleted
     * @param versionUUIDs the UUIDs of the versions associated to the deleted document
     * @return the "filtred" list of versions that can be removed
     */
    List<String> getRemovableVersionIds(CoreSession session, ShallowDocumentModel deletedLiveDoc,
            List<String> versionUUIDs);
}