001    /*
002     * Copyright 2005-2008 The Kuali Foundation
003     * 
004     * 
005     * Licensed under the Educational Community License, Version 2.0 (the "License");
006     * you may not use this file except in compliance with the License.
007     * You may obtain a copy of the License at
008     * 
009     * http://www.opensource.org/licenses/ecl2.php
010     * 
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.kuali.rice.kew.engine.node;
018    
019    import org.kuali.rice.kew.engine.RouteContext;
020    
021    /**
022     * The JoinEngine is responsible for maintaining join state and determining when the join condition
023     * has been satisfied.
024     *
025     * @author Kuali Rice Team (rice.collab@kuali.org)
026     */
027    public interface JoinEngine {
028    
029        public void addExpectedJoiner(RouteNodeInstance nodeInstance, Branch branch);
030        
031        public void addActualJoiner(RouteNodeInstance nodeInstance, Branch branch);
032        
033        public boolean isJoined(RouteNodeInstance nodeInstance);
034        
035        public void createExpectedJoinState(RouteContext context, RouteNodeInstance joinInstance, RouteNodeInstance previousNodeInstance);
036    }