001/*
002 * (C) Copyright 2018 Nuxeo (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 *     Guillaume Renard <grenard@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.collectors.DocumentModelCollector;
026import org.nuxeo.ecm.core.api.CoreSession;
027import org.nuxeo.ecm.core.api.DocumentModel;
028import org.nuxeo.ecm.core.api.NuxeoException;
029import org.nuxeo.ecm.core.trash.TrashService;
030
031/**
032 * @since 10.1
033 */
034@Operation(id = UntrashDocument.ID, category = Constants.CAT_DOCUMENT, label = "Untrash", description = "Undeletes documents (and ancestors if needed to make them visible)..")
035public class UntrashDocument {
036
037    public static final String ID = "Document.Untrash";
038
039    @Context
040    protected CoreSession session;
041
042    @Context
043    protected TrashService trashService;
044
045    @OperationMethod(collector = DocumentModelCollector.class)
046    public DocumentModel run(DocumentModel doc) {
047        if (trashService.canPurgeOrUntrash(doc, session.getPrincipal())) {
048            trashService.untrashDocument(doc);
049            return session.getDocument(doc.getRef());
050        } else {
051            throw new NuxeoException("Cannot untrash these documents");
052        }
053    }
054
055}