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.annotations.Param;
026import org.nuxeo.ecm.core.api.DocumentModel;
027import org.nuxeo.ecm.core.api.trash.TrashService;
028
029/**
030 * @since 10.1
031 */
032@Operation(id = EmptyTrash.ID, category = Constants.CAT_DOCUMENT, label = "Empty Trash", description = "Emtpy a folder's trash by permanently deleting documents marked as trashed.")
033public class EmptyTrash {
034
035    public static final String ID = "Document.EmptyTrash";
036
037    @Context
038    protected TrashService trashService;
039
040    @Param(name = "parent", description = "A Folderish document whose trash will be emptied")
041    protected DocumentModel parent;
042
043    @OperationMethod()
044    public void run() {
045        trashService.purgeDocumentsUnder(parent);
046    }
047
048}