001/*
002 * Licensed to DuraSpace under one or more contributor license agreements.
003 * See the NOTICE file distributed with this work for additional information
004 * regarding copyright ownership.
005 *
006 * DuraSpace licenses this file to you under the Apache License,
007 * Version 2.0 (the "License"); you may not use this file except in
008 * compliance with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.fcrepo.kernel.api.services;
019
020import org.fcrepo.kernel.api.FedoraSession;
021
022/**
023 * @author bbpennel
024 * @since Feb 19, 2014
025 */
026public interface VersionService {
027
028    /**
029     * Explicitly creates a version for the nodes at each path provided.
030     *
031     * @param session the session in which the node resides
032     * @param absPath absolute paths to the node
033     * @param label a label to be applied to the new version
034     * @return the identifier
035     */
036    String createVersion(FedoraSession session, String absPath, String label);
037
038    /**
039     * Reverts the node to the version identified by the label.  This method
040     * will throw a PathNotFoundException if no version with the given label is
041     * found.
042     *
043     * @param session the session in which the node resides
044     * @param absPath the path to the node whose version is to be reverted
045     * @param label identifies the historic version
046     */
047    void revertToVersion(FedoraSession session, String absPath, String label);
048
049    /**
050     * Remove a version of a node.  This method will throw a PathNotFoundException
051     * if no version with the given label is found.
052     *
053     * @param session the session in which the node resides
054     * @param absPath the path to the node whose version is to be removed
055     * @param label identifies the historic version by label or id
056     */
057    void removeVersion(FedoraSession session, String absPath, String label);
058
059}