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.krms.api.engine;
017    
018    /**
019     * Interface for the engine that is used to resolve {@link Term}s.
020     * 
021     * @author Kuali Rice Team (rice.collab@kuali.org)
022     *
023     */
024    public interface TermResolutionEngine {
025    
026            /**
027             * Resolves a given term into a fact
028             * @param term the {@link Term} to resolve
029             * @return the fact value for the given {@link Term}
030             * @throws {@link TermResolutionException} if the given {@link Term} can't be resolved
031             */
032            <T> T resolveTerm(Term term) throws TermResolutionException;
033            
034            /**
035             * Adds a fact value to the {@link TermResolutionEngine}'s internal state
036             * @param term the named Term
037             * @param value the fact value
038             */
039            void addTermValue(Term term, Object value);
040            
041            /**
042             * Adds a {@link TermResolver} to the {@link TermResolutionEngine}.  Once added, it may
043             * be used (unsurprisingly) by the engine to resolve {@link Term}s.
044             * @param termResolver the {@link TermResolver} to add.
045             */
046            void addTermResolver(TermResolver<?> termResolver);
047            
048    }