001/*
002 * (C) Copyright 2013 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 *     Antoine Taillefer <ataillefer@nuxeo.com>
018 */
019package org.nuxeo.ecm.automation.core.operations.document;
020
021import org.nuxeo.ecm.automation.core.Constants;
022import org.nuxeo.ecm.automation.core.annotations.Context;
023import org.nuxeo.ecm.automation.core.annotations.Operation;
024import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
025import org.nuxeo.ecm.automation.core.annotations.Param;
026import org.nuxeo.ecm.core.api.CoreSession;
027import org.nuxeo.ecm.core.api.DocumentModel;
028
029/**
030 * Restores a document to the input version document.
031 *
032 * @since 5.7.3
033 * @author Antoine Taillefer
034 */
035@Operation(id = RestoreVersion.ID, category = Constants.CAT_DOCUMENT, label = "Restore Version", description = "Restores a document to the input version document. If createVersion is true, a version of the live document will be created before restoring it to the input version. If checkout is true, a checkout will be processed after restoring the document, visible in the UI by the '+' symbol beside the version number. Returns the restored document.")
036public class RestoreVersion {
037
038    public static final String ID = "Document.RestoreVersion";
039
040    @Context
041    protected CoreSession session;
042
043    @Param(name = "createVersion", required = false, values = "false")
044    protected boolean createVersion = false;
045
046    @Param(name = "checkout", required = false, values = "false")
047    protected boolean checkout = false;
048
049    @OperationMethod
050    public DocumentModel run(DocumentModel version) {
051        DocumentModel liveDoc = session.getSourceDocument(version.getRef());
052        return session.restoreToVersion(liveDoc.getRef(), version.getRef(), !createVersion, !checkout);
053    }
054
055}