001/**
002 * Copyright 2005-2017 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 */
016package org.kuali.rice.kew.engine;
017
018import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
019
020/**
021 * Defines the contract to the core workflow engine.  The standard unit of work of the engine
022 * is the process method.  Document must also be initialized by the WorkflowEngine when they
023 * are initially created.
024 * 
025 * @author Kuali Rice Team (rice.collab@kuali.org)
026 *
027 */
028public interface WorkflowEngine {
029        
030    public void process(String documentId, String nodeInstanceId) throws Exception;
031    
032    /**
033     * @throws IllegalDocumentTypeException if the given document could not be initialized successfully
034     */
035    public void initializeDocument(DocumentRouteHeaderValue document);
036
037    
038}