001/*
002 * (C) Copyright 2010 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 *     Nuxeo - initial API and implementation
016 */
017package org.nuxeo.ecm.platform.routing.api;
018
019import org.nuxeo.ecm.core.api.CoreSession;
020import org.nuxeo.ecm.core.api.DocumentModelList;
021import org.nuxeo.ecm.platform.routing.api.helper.ActionableValidator;
022
023/**
024 * An actionable object is an object that can be validated or refused.
025 *
026 * @see ActionableValidator
027 * @author <a href="mailto:arussel@nuxeo.com">Alexandre Russel</a>
028 * @deprecated since 5.9.2 - Use only routes of type 'graph'
029 */
030@Deprecated
031public interface ActionableObject {
032
033    /**
034     * The operation chain id if the action is refused.
035     *
036     * @return
037     */
038    String getRefuseOperationChainId();
039
040    /**
041     * The operation chain id if the action is validated.
042     *
043     * @return
044     */
045    String getValidateOperationChainId();
046
047    /**
048     * The step that represent the action.
049     *
050     * @param session
051     * @return
052     */
053    DocumentRouteStep getDocumentRouteStep(CoreSession session);
054
055    /**
056     * The documents processed by the action.
057     */
058    DocumentModelList getAttachedDocuments(CoreSession session);
059
060}