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 *     Florent Guillaume
018 */
019
020package org.nuxeo.ecm.core.versioning;
021
022import org.nuxeo.ecm.core.api.CoreSession;
023import org.nuxeo.ecm.core.model.Document;
024import org.nuxeo.ecm.core.model.Session;
025
026/**
027 * Interface for the policy that decides which versions have to be removed when a working document is removed. This
028 * policy is called at the AbstractSession level.
029 *
030 * @author Florent Guillaume
031 */
032public interface VersionRemovalPolicy {
033
034    /**
035     * Removes the versions when a given working document is about to be removed.
036     *
037     * @param session the current session
038     * @param doc the document that is about to be removed
039     */
040    void removeVersions(Session session, Document doc, CoreSession coreSession);
041
042}