001/*
002 * (C) Copyright 2013 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 *     Mariana Cedica
018 */
019package org.nuxeo.ecm.platform.routing.core.api;
020
021import java.util.List;
022
023import org.nuxeo.ecm.core.api.CoreSession;
024import org.nuxeo.ecm.platform.routing.core.impl.GraphNode;
025import org.nuxeo.ecm.platform.routing.core.impl.GraphNode.EscalationRule;
026
027/**
028 * @since 5.7.2
029 */
030public interface DocumentRoutingEscalationService {
031
032    /**
033     * Query all running workflows and returns a list of nodes that are suspended and have escalation rules that can be
034     * inspected. Uses an unrestricted session.
035     *
036     * @return
037     * @since 5.7.2
038     */
039    List<String> queryForSuspendedNodesWithEscalation(CoreSession session);
040
041    /**
042     * Computes the list of escalation rules to be executed after their conditions are evaluated for the given node.
043     *
044     * @return
045     * @since 5.7.2
046     */
047    public List<EscalationRule> computeEscalationRulesToExecute(GraphNode node);
048
049    /**
050     * Schedules for execution an escalation rule. Uses an unrestricted session.
051     *
052     * @param rule
053     * @since 5.7.2
054     */
055    void scheduleExecution(EscalationRule rule, CoreSession session);
056}