001    /**
002     * Copyright 2005-2011 The Kuali Foundation
003     *
004     * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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    package org.kuali.rice.kew.routemodule.service;
017    
018    import org.kuali.rice.kew.engine.simulation.SimulationCriteria;
019    import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
020    
021    
022    /**
023     * A service for executing routing reports from {@link SimulationCriteria}.
024     *
025     * @author Kuali Rice Team (rice.collab@kuali.org)
026     */
027    public interface RoutingReportService {
028    
029            //public DocumentRouteHeaderValue report(String documentId, Integer startRouteLevel, Integer endRouteLevel, List usersToFilterIn) throws WorkflowException;
030            
031            //public DocumentRouteHeaderValue report(String documentTypeName, DocumentContent documentContent, Integer startRouteLevel, Integer endRouteLevel, List usersToFilterIn) throws WorkflowException;
032            
033            //public DocumentRouteHeaderValue simulationReport(DocumentRouteHeaderValue document, List actionsToTake) throws WorkflowException;
034        
035        public DocumentRouteHeaderValue report(SimulationCriteria criteria);
036            
037    }