View Javadoc

1   package net.sourceforge.blogentis.plugins.base;
2   
3   //-----------------------------------------------------------------------
4   //Blogentis - a blog publishing platform.
5   //Copyright (C) 2004 Tassos Bassoukos <abassouk@gmail.com>
6   //
7   //This library is free software; you can redistribute it and/or
8   //modify it under the terms of the GNU Lesser General Public
9   //License as published by the Free Software Foundation; either
10  //version 2.1 of the License, or (at your option) any later version.
11  //
12  //This library is distributed in the hope that it will be useful,
13  //but WITHOUT ANY WARRANTY; without even the implied warranty of
14  //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  //Lesser General Public License for more details.
16  //
17  //You should have received a copy of the GNU Lesser General Public
18  //License along with this library; if not, write to the Free Software
19  //Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  //-----------------------------------------------------------------------
21  //
22  //$Id: INavigationExtensionPoint.java,v 1.1 2004/10/22 17:34:12 tassos Exp $
23  //
24  
25  import java.util.List;
26  
27  import net.sourceforge.blogentis.plugins.IBlogExtensionPoint;
28  import net.sourceforge.blogentis.turbine.BlogRunData;
29  
30  /***
31   * This is an extension point for managing the different navigation lists of a
32   * blog.
33   * 
34   * @author abas
35   */
36  public interface INavigationExtensionPoint
37          extends IBlogExtensionPoint {
38      /***
39       * Builds and return the specified navigation list. If the list has no
40       * elements, the navigation list should not be visible.
41       * 
42       * @param data
43       *            the BlogRunData of the current request.
44       * @param navName
45       *            the name of the navigation list.
46       * @return a List of ILinkTo objects.
47       */
48      public List buildNavigationList(BlogRunData data, String navName);
49  }