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: IPostViewExtension.java,v 1.1 2004/10/22 17:34:13 tassos Exp $
23 //
24
25 import net.sourceforge.blogentis.om.Post;
26 import net.sourceforge.blogentis.plugins.IBlogExtension;
27 import net.sourceforge.blogentis.turbine.BlogRunData;
28
29 /***
30 * This extension will be invoked whenever a post is about to be viewed, either
31 * in an HTML page or in an RSS Feed. Actions could include preparing a word
32 * count, substituting acronyms with links, anything.
33 *
34 * The returned post can even be a new object.
35 *
36 * @author abas
37 */
38 public interface IPostViewExtension extends IBlogExtension {
39 /***
40 * Prepare a post for viewing. This method is free to make with the post
41 * anything, except saving it to disk. The return value is at this time the
42 * Post itself.
43 *
44 * @param data
45 * the run-time data of the request
46 * @param post
47 * the post that will be prepared
48 * @return the post as processed.
49 */
50 public Post prepareForView(BlogRunData data, Post post);
51 }