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 *     <a href="mailto:glefevre@nuxeo.com">Gildas</a>
018 */
019package org.nuxeo.ecm.automation.core.operations.collections;
020
021import org.nuxeo.ecm.automation.core.Constants;
022import org.nuxeo.ecm.automation.core.annotations.Context;
023import org.nuxeo.ecm.automation.core.annotations.Operation;
024import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
025import org.nuxeo.ecm.automation.core.annotations.Param;
026import org.nuxeo.ecm.collections.api.CollectionManager;
027import org.nuxeo.ecm.core.api.CoreSession;
028import org.nuxeo.ecm.core.api.DocumentModel;
029import org.nuxeo.ecm.core.api.DocumentModelList;
030
031/**
032 * Class for the operation to add a list of documents in a Collection.
033 *
034 * @since 5.9.4
035 */
036@Operation(id = AddToCollectionOperation.ID, category = Constants.CAT_DOCUMENT, label = "Add document to collection", description = "Add a list of documents in a collection. "
037        + "No value is returned.", aliases = { "Collection.AddToCollection" })
038public class AddToCollectionOperation {
039
040    public static final String ID = "Document.AddToCollection";
041
042    @Context
043    protected CoreSession session;
044
045    @Context
046    protected CollectionManager collectionManager;
047
048    @Param(name = "collection")
049    protected DocumentModel collection;
050
051    @OperationMethod
052    public DocumentModelList run(DocumentModelList docs) {
053        for (DocumentModel doc : docs) {
054            collectionManager.addToCollection(collection, doc, session);
055        }
056
057        return docs;
058    }
059
060    @OperationMethod()
061    public DocumentModel run(DocumentModel doc) {
062        collectionManager.addToCollection(collection, doc, session);
063
064        return doc;
065    }
066}