001/*
002 * (C) Copyright 2014 Nuxeo SA (http://nuxeo.com/) and contributors.
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 *     Antoine Taillefer <ataillefer@nuxeo.com>
016 */
017package org.nuxeo.drive.operations;
018
019import org.nuxeo.drive.service.NuxeoDriveManager;
020import org.nuxeo.ecm.automation.core.Constants;
021import org.nuxeo.ecm.automation.core.annotations.Context;
022import org.nuxeo.ecm.automation.core.annotations.Operation;
023import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
024import org.nuxeo.ecm.core.api.CoreSession;
025import org.nuxeo.ecm.core.api.DocumentModel;
026import org.nuxeo.runtime.api.Framework;
027
028/**
029 * Adds the given {@link DocumentModel} to the {@link NuxeoDriveManager#LOCALLY_EDITED_COLLECTION_NAME} collection.
030 *
031 * @author Antoine Taillefer
032 * @since 6.0
033 */
034@Operation(id = NuxeoDriveAddToLocallyEditedCollection.ID, category = Constants.CAT_SERVICES, label = "Nuxeo Drive: Add document to the 'Locally Edited' collection")
035public class NuxeoDriveAddToLocallyEditedCollection {
036
037    public static final String ID = "NuxeoDrive.AddToLocallyEditedCollection";
038
039    @Context
040    protected CoreSession session;
041
042    @OperationMethod
043    public DocumentModel run(DocumentModel doc) {
044        NuxeoDriveManager nuxeoDriveManager = Framework.getService(NuxeoDriveManager.class);
045        nuxeoDriveManager.addToLocallyEditedCollection(session, doc);
046        return doc;
047    }
048
049}