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 *     Nuxeo - initial API and implementation
018 *
019 * $Id: JOOoConvertPluginImpl.java 18651 2007-05-13 20:28:53Z sfermigier $
020 */
021
022package org.nuxeo.ecm.core.api.facet;
023
024/**
025 * Declares constants and methods used to control document versions mostly when a document is saved.
026 *
027 * @author <a href="mailto:dm@nuxeo.com">Dragos Mihalache</a>
028 */
029public interface VersioningDocument {
030
031    /**
032     * @deprecated use {@link VersioningService#VERSIONING_OPTION} instead
033     */
034    @Deprecated
035    String CREATE_SNAPSHOT_ON_SAVE_KEY = "CREATE_SNAPSHOT_ON_SAVE";
036
037    /**
038     * @deprecated use {@link VersioningService#VERSIONING_OPTION} instead
039     */
040    @Deprecated
041    String KEY_FOR_INC_OPTION = "VersioningOption";
042
043    /**
044     * Key used in options map to send current versions to versioning listener so it will know what version the document
045     * had before restoring.
046     */
047    String CURRENT_DOCUMENT_MINOR_VERSION_KEY = "CURRENT_DOCUMENT_MINOR_VERSION";
048
049    String CURRENT_DOCUMENT_MAJOR_VERSION_KEY = "CURRENT_DOCUMENT_MAJOR_VERSION";
050
051    /**
052     * Key used in options map to send the UUID of the version being restored to the listeners.
053     */
054    String RESTORED_VERSION_UUID_KEY = "RESTORED_VERSION_UUID";
055
056    /**
057     * @deprecated use {@link VersioningService#getVersionLabel} instead
058     */
059    @Deprecated
060    Long getMinorVersion();
061
062    /**
063     * @deprecated use {@link VersioningService#getVersionLabel} instead
064     */
065    @Deprecated
066    Long getMajorVersion();
067
068    /**
069     * Returns a string representation of the version number.
070     *
071     * @return a string, like {@code "2.1"}
072     */
073    String getVersionLabel();
074
075}