001/*
002 * (C) Copyright 2012-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 *      Vladimir Pasquier <vpasquier@nuxeo.com>
018 *      Thibaud Arguillere <targuillere@nuxeo.com>
019 */
020package org.nuxeo.ecm.platform.tag.operations;
021
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.automation.core.annotations.Param;
027import org.nuxeo.ecm.automation.core.collectors.DocumentModelCollector;
028import org.nuxeo.ecm.automation.core.util.StringList;
029import org.nuxeo.ecm.core.api.CoreSession;
030import org.nuxeo.ecm.core.api.DocumentModel;
031import org.nuxeo.ecm.platform.tag.TagService;
032
033import java.util.Collections;
034
035/**
036 * @since 7.1 Tag a document with one or several 'tags'.
037 */
038@Operation(id = TagDocument.ID, category = Constants.CAT_SERVICES, label = "Tag Document", description = "Tag document with one or "
039        + "several 'tags'.", since = "7.1", addToStudio = true)
040public class TagDocument {
041
042    public static final String ID = "Services.TagDocument";
043
044    @Context
045    protected TagService tagService;
046
047    @Context
048    protected CoreSession session;
049
050    @Param(name = "tags", required = true, description = "Labels or tags " + "separated by comma.")
051    protected StringList tags;
052
053    @OperationMethod(collector = DocumentModelCollector.class)
054    public DocumentModel run(DocumentModel document) {
055        if (tags != null) {
056            tags.removeAll(Collections.singleton(""));
057            for (String tag : tags) {
058                tagService.tag(session, document.getId(), tag);
059            }
060        }
061        return document;
062    }
063}