001    /* PAVLOV -- Multiple Choice Study System
002     * Copyright (C) 2000 - 2004 T.J. Willis
003     * 
004     * This program is free software; you can redistribute it and/or
005     * modify it under the terms of the GNU General Public License
006     * as published by the Free Software Foundation; either version 2
007     * of the License, or (at your option) any later version.
008     *      
009     * This program is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012     * GNU General Public License for more details.
013     *          
014     * You should have received a copy of the GNU General Public License
015     * along with this program; if not, write to the Free Software
016     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
017     *  
018     * $Header: /cvsroot/pavlov/net/sourceforge/pavlov/main/AbstractTemplateKit.java,v 1.2 2004/05/16 18:55:49 tj_willis Exp $
019     */ 
020    package net.sourceforge.pavlov.main;
021    
022    
023    
024    /**
025     * Provides a set of templates for widgets that allow the user to login,
026     * choose a chapter, answer a question, and be welcomed to the application.
027     * Also provides the directory in which these templates reside.
028     *
029     * @author <a href="mailto:tj_willis@users.sourceforge.net">T.J. Willis</a>
030     * @version 1.0
031     * @since 1.1
032     */
033    public interface AbstractTemplateKit
034    {
035    
036        /**
037         * Return the template used to log the user in.
038         *
039         * @return a <code>String</code> value
040         */
041        String getLoginTemplate();
042        /**
043         * Return the template the user uses to select a chapter to quiz on.
044         *
045         * @return a <code>String</code> value
046         */
047        String getLibraryTemplate();
048        /**
049         * Return the template used to display a question during a quiz.
050         *
051         * @return a <code>String</code> value
052         */
053        String getQuizTemplate();
054        /**
055         * Return the template used to welcome a user to Pavlov.
056         *
057         * @return a <code>String</code> value
058         */
059        String getWelcomeTemplate();
060        /**
061         * Return the directory in which these templates reside.
062         *
063         * @return a <code>java.io.File</code> value
064         */
065        java.io.File   getBaseDir();
066    }
067