001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.file.history;
029
030import org.opencms.file.I_CmsResource;
031import org.opencms.util.CmsUUID;
032
033import java.io.Serializable;
034
035/**
036 * A historical version of a resource in the OpenCms VFS resource history.<p>
037 *
038 * History resources are resources that contain additional information
039 * used to describe the historical state.<p>
040 *
041 * The historical resource object extends the resource object since it be
042 * an history for a file as well as for a folder.<p>
043 *
044 * History resources contain the names of the users that created or last
045 * modified the resource as string obejcts because a user id might have been
046 * deleted.<p>
047 *
048 * @since 6.9.1
049 */
050public interface I_CmsHistoryResource extends I_CmsResource, Cloneable, Serializable, Comparable<I_CmsResource> {
051
052    /**
053     * Returns the structure id of the parent resource.<p>
054     *
055     * @return the structure id of the parent resource
056     */
057    CmsUUID getParentId();
058
059    /**
060     * Returns the publish tag of this historical resource.<p>
061     *
062     * @return the publish tag of this historical resource
063     */
064    int getPublishTag();
065
066    /**
067     * Returns the version number of the resource part for this historical resource.<p>
068     *
069     * @return the version number of the resource part for this historical resource
070     */
071    int getResourceVersion();
072
073    /**
074     * Returns the version number of the structure part for this historical resource.<p>
075     *
076     * @return the version number of the structure part for this historical resource
077     */
078    int getStructureVersion();
079
080    /**
081     * Returns the version number of this historical resource.<p>
082     *
083     * @return the version number of this historical resource
084     */
085    int getVersion();
086}