001    /**
002     * Copyright 2005-2012 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.engine.node;
017    
018    import org.kuali.rice.kew.engine.RouteContext;
019    
020    /**
021     * The JoinEngine is responsible for maintaining join state and determining when the join condition
022     * has been satisfied.
023     *
024     * @author Kuali Rice Team (rice.collab@kuali.org)
025     */
026    public interface JoinEngine {
027    
028        public void addExpectedJoiner(RouteNodeInstance nodeInstance, Branch branch);
029        
030        public void addActualJoiner(RouteNodeInstance nodeInstance, Branch branch);
031        
032        public boolean isJoined(RouteNodeInstance nodeInstance);
033        
034        public void createExpectedJoinState(RouteContext context, RouteNodeInstance joinInstance, RouteNodeInstance previousNodeInstance);
035    }