001    package echopoint.template;
002    /* 
003     * This file is part of the Echo Point Project.  This project is a collection
004     * of Components that have extended the Echo Web Application Framework.
005     *
006     * Version: MPL 1.1/GPL 2.0/LGPL 2.1
007     *
008     * The contents of this file are subject to the Mozilla Public License Version
009     * 1.1 (the "License"); you may not use this file except in compliance with
010     * the License. You may obtain a copy of the License at
011     * http://www.mozilla.org/MPL/
012     *
013     * Software distributed under the License is distributed on an "AS IS" basis,
014     * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
015     * for the specific language governing rights and limitations under the
016     * License.
017     *
018     * Alternatively, the contents of this file may be used under the terms of
019     * either the GNU General Public License Version 2 or later (the "GPL"), or
020     * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
021     * in which case the provisions of the GPL or the LGPL are applicable instead
022     * of those above. If you wish to allow use of your version of this file only
023     * under the terms of either the GPL or the LGPL, and not to allow others to
024     * use your version of this file under the terms of the MPL, indicate your
025     * decision by deleting the provisions above and replace them with the notice
026     * and other provisions required by the GPL or the LGPL. If you do not delete
027     * the provisions above, a recipient may use your version of this file under
028     * the terms of any one of the MPL, the GPL or the LGPL.
029     */
030    
031    import java.io.Serializable;
032    
033    /**
034     * This interface is used substitue named "text tags" in the 
035     * template markup with  variable Strings.
036     * <p>
037     * A single <code>TemplateTextSubstitution</code> can be used by more than
038     * one <code>TemplatePanel</code>.  This helps reduce the memory footprint
039     * of the template text subsitution.  An implementation of this interface
040     * must keep the requirement in mind.
041     */
042    public interface TemplateTextSubstitution extends Serializable {
043            /**
044             * This method is called to return a String that has been associated with the 
045             * given substitution name.  If the name is unknown, then
046             * null should be returned.
047             */
048            public String getSubstitutionText(String substitutionName);
049    }