001/*
002 * (C) Copyright 2013 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl-2.1.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Thomas Roger
016 */
017
018package org.nuxeo.ecm.webapp.bulkedit;
019
020import java.util.List;
021
022import org.nuxeo.ecm.core.api.CoreSession;
023import org.nuxeo.ecm.core.api.DocumentModel;
024
025/**
026 * Service handling bulk edition of documents.
027 *
028 * @since 5.7.3
029 */
030public interface BulkEditService {
031
032    String BULK_EDIT_PREFIX = "bulkEdit/";
033
034    String CONTEXT_DATA = "contextData";
035
036    /**
037     * Copy all the marked properties (stored in the ContextData of {@code sourceDoc}) from {@code sourceDoc} to all the
038     * {@code targetDocs}.
039     *
040     * @param session the {@code CoreSession} to use
041     * @param sourceDoc the doc where to get the properties to copy
042     * @param targetDocs the docs where to set the properties
043     */
044    void updateDocuments(CoreSession session, DocumentModel sourceDoc, List<DocumentModel> targetDocs);
045
046}