001    /**
002     * Copyright 2005-2014 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.krms.framework.engine;
017    
018    import org.kuali.rice.krms.api.engine.ExecutionEnvironment;
019    
020    /**
021     * A {@link Rule} which executes it's {@link AgendaTree} given a @{link ExecutionEnvironment}.
022     *
023     * @author Kuali Rice Team (rice.collab@kuali.org)
024     */
025    public class SubAgenda implements Rule {
026    
027            private AgendaTree agendaTree;
028    
029        /**
030         * Create a SubAgenda with the given {@link AgendaTree}
031         * @param agendaTree {@link AgendaTree} to create the SubAgenda with.
032         */
033            public SubAgenda(AgendaTree agendaTree) {
034                    this.agendaTree = agendaTree;
035            }
036            
037            @Override
038            public boolean evaluate(ExecutionEnvironment environment) {
039                    agendaTree.execute(environment);
040                    return true;
041            }
042    
043    }