001/*
002 * (C) Copyright 2016 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:grenard@nuxeo.com">Guillaume Renard</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.collections.api.FavoritesManager;
026import org.nuxeo.ecm.core.api.CoreSession;
027import org.nuxeo.ecm.core.api.DocumentModel;
028import org.nuxeo.ecm.core.api.DocumentModelList;
029
030/**
031 * Class for the operation to remove a list of documents from the Favorites.
032 *
033 * @since 8.1
034 */
035@Operation(id = RemoveFromFavoritesOperation.ID, category = Constants.CAT_DOCUMENT, label = "Remove from favorites", description = "Remove a list of documents from the favorites. "
036        + "No value is returned.", aliases = { "Collection.RemoveFromFavorites" })
037public class RemoveFromFavoritesOperation {
038    public static final String ID = "Document.RemoveFromFavorites";
039
040    @Context
041    protected CoreSession session;
042
043    @Context
044    protected FavoritesManager favoritesManager;
045
046    @OperationMethod
047    public DocumentModelList run(DocumentModelList docs) {
048        for (DocumentModel doc : docs) {
049            favoritesManager.removeFromFavorites(doc, session);
050        }
051
052        return docs;
053    }
054
055    @OperationMethod
056    public DocumentModel run(DocumentModel doc) {
057        favoritesManager.removeFromFavorites(doc, session);
058
059        return doc;
060    }
061}