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