001/*
002 * (C) Copyright 2006-2016 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 */
019package org.nuxeo.ecm.core.api.facet;
020
021/**
022 * Declares constants and methods used to control document versions mostly when a document is saved.
023 *
024 * @author <a href="mailto:[email protected]">Dragos Mihalache</a>
025 */
026public interface VersioningDocument {
027
028    /**
029     * Key used in options map to send current versions to versioning listener so it will know what version the document
030     * had before restoring.
031     */
032    String CURRENT_DOCUMENT_MINOR_VERSION_KEY = "CURRENT_DOCUMENT_MINOR_VERSION";
033
034    String CURRENT_DOCUMENT_MAJOR_VERSION_KEY = "CURRENT_DOCUMENT_MAJOR_VERSION";
035
036    /**
037     * Key used in options map to send the UUID of the version being restored to the listeners.
038     */
039    String RESTORED_VERSION_UUID_KEY = "RESTORED_VERSION_UUID";
040
041    /**
042     * Returns a string representation of the version number.
043     *
044     * @return a string, like {@code "2.1"}
045     */
046    String getVersionLabel();
047
048}