001/*
002 * (C) Copyright 2011 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     ldoguin
016 */
017package org.nuxeo.ecm.platform.routing.api;
018
019import java.util.List;
020import java.util.Map;
021
022import org.nuxeo.ecm.core.api.CoreSession;
023import org.nuxeo.ecm.core.api.DocumentModel;
024import org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteException;
025import org.nuxeo.ecm.platform.task.Task;
026
027/**
028 * A small service adding Routing behavior to tasks.
029 * <p>
030 * 
031 * @deprecated since 5.6, use DocumentRoutingService instead
032 */
033@Deprecated
034public interface RoutingTaskService {
035
036    /**
037     * Marks the tasks as Routing tasks.
038     * <p>
039     * This allows the related documents to be adapted to {@link RoutingTask}.
040     *
041     * @param session the session
042     * @param tasks the tasks
043     * @deprecated since 5.6, use DocumentRoutingService instead
044     */
045    @Deprecated
046    void makeRoutingTasks(CoreSession session, List<Task> tasks);
047
048    /**
049     * Ends a task
050     *
051     * @param session
052     * @param task
053     * @param data
054     * @param status name of the button clicked to submit the task form
055     * @throws DocumentRouteException
056     * @deprecated since 5.6, use DocumentRoutingService instead
057     */
058    @Deprecated
059    void endTask(CoreSession session, Task task, Map<String, Object> data, String status) throws DocumentRouteException;
060
061    /**
062     * Gets the documents following the workflow to which the given task belongs
063     *
064     * @param session
065     * @param task
066     * @return
067     * @throws DocumentRouteException
068     * @deprecated since 5.6, use DocumentRoutingService instead
069     */
070    @Deprecated
071    List<DocumentModel> getWorkflowInputDocuments(CoreSession session, Task task) throws DocumentRouteException;
072}