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 *     Thomas Roger
018 */
019
020package org.nuxeo.ecm.webapp.bulkedit;
021
022import java.util.List;
023
024import org.nuxeo.ecm.core.api.CoreSession;
025import org.nuxeo.ecm.core.api.DocumentModel;
026
027/**
028 * Service handling bulk edition of documents.
029 *
030 * @since 5.7.3
031 */
032public interface BulkEditService {
033
034    String BULK_EDIT_PREFIX = "bulkEdit/";
035
036    String CONTEXT_DATA = "contextData";
037
038    /**
039     * Copy all the marked properties (stored in the ContextData of {@code sourceDoc}) from {@code sourceDoc} to all the
040     * {@code targetDocs}.
041     *
042     * @param session the {@code CoreSession} to use
043     * @param sourceDoc the doc where to get the properties to copy
044     * @param targetDocs the docs where to set the properties
045     */
046    void updateDocuments(CoreSession session, DocumentModel sourceDoc, List<DocumentModel> targetDocs);
047
048}