1 /**
2 * Copyright 2005-2013 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kew.engine;
17
18 import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
19
20 /**
21 * Defines the contract to the core workflow engine. The standard unit of work of the engine
22 * is the process method. Document must also be initialized by the WorkflowEngine when they
23 * are initially created.
24 *
25 * @author Kuali Rice Team (rice.collab@kuali.org)
26 *
27 */
28 public interface WorkflowEngine {
29
30 public void process(String documentId, String nodeInstanceId) throws Exception;
31
32 /**
33 * @throws IllegalDocumentTypeException if the given document could not be initialized successfully
34 */
35 public void initializeDocument(DocumentRouteHeaderValue document);
36
37
38 }