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