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 <ataillefer@nuxeo.com>
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
032 * {@link org.nuxeo.drive.service.impl.NuxeoDriveManagerImpl#LOCALLY_EDITED_COLLECTION_NAME} collection.
033 *
034 * @author Antoine Taillefer
035 * @since 6.0
036 * @deprecated since 10.3
037 */
038@Deprecated
039@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." //
040        + " Return the input document.", deprecatedSince = "10.3")
041public class NuxeoDriveAddToLocallyEditedCollection {
042
043    public static final String ID = "NuxeoDrive.AddToLocallyEditedCollection";
044
045    @Context
046    protected CoreSession session;
047
048    @OperationMethod
049    public DocumentModel run(DocumentModel doc) {
050        NuxeoDriveManager nuxeoDriveManager = Framework.getService(NuxeoDriveManager.class);
051        nuxeoDriveManager.addToLocallyEditedCollection(session, doc);
052        return doc;
053    }
054
055}