001/*
002 * Copyright 2015 DuraSpace, Inc.
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 */
016package org.fcrepo.migration;
017
018/**
019 * An interface for a class that processes Fedora 3 objects
020 * as an iteration of versions.  The single method
021 * {@link #processObjectVersions} would be invoked once for
022 * an object providing the entire version history (ie. times
023 * with identifiable changes) in the Fedora 3 object
024 * starting from the creation and proceeding chronologically
025 * @author mdurbin
026 */
027public interface FedoraObjectVersionHandler {
028
029    /**
030     * Invoked to process a version of a Fedora 3 object.  All the metadata
031     * and content that changed from the previous version to the one
032     * represented by the current call is conventiently made available.
033     * @param versions an iterable of Objects each encapsulating everything
034     *               about a single version of a Fedora 3 object.
035     * @param objectInfo information about the Fedora 3 object being processed
036     */
037    public void processObjectVersions(Iterable<ObjectVersionReference> versions, final ObjectInfo objectInfo);
038}