001/*
002 * (C) Copyright 2009 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 *     arussel
016 */
017package org.nuxeo.ecm.platform.routing.api;
018
019import java.util.List;
020
021import org.nuxeo.ecm.core.api.CoreSession;
022
023/**
024 * A DocumentRoute model or instance. A route is a set of step that processes documents. If a method is called that
025 * change the state of this object, the {@link #save(CoreSession)} method should be called to persist its state.
026 *
027 * @author arussel
028 */
029public interface DocumentRoute extends DocumentRouteStepsContainer {
030
031    /**
032     * Set the list of id of documents attached to this instance of RouteModel replacing the previous list if any.
033     *
034     * @param documents
035     */
036    void setAttachedDocuments(List<String> documentIds);
037
038    /**
039     * The list of documents processed by this route.
040     *
041     * @return
042     */
043    List<String> getAttachedDocuments();
044
045
046    /**
047     * Get the username of the initiator.
048     *
049     * @since 7.2
050     */
051    String getInitiator();
052
053    /**
054     * @since 7.2
055     */
056    String getModelId();
057
058    /**
059     * @since 7.2
060     */
061    String getModelName();
062
063}