View Javadoc

1   package net.sourceforge.blogentis.om;
2   
3   import java.util.List;
4   
5   import net.sourceforge.blogentis.utils.MappedConfiguration;
6   
7   import org.apache.torque.TorqueException;
8   
9   //-----------------------------------------------------------------------
10  //Blogentis - a blog publishing platform.
11  //Copyright (C) 2004 Tassos Bassoukos <abassouk@gmail.com>
12  //
13  //This library is free software; you can redistribute it and/or
14  //modify it under the terms of the GNU Lesser General Public
15  //License as published by the Free Software Foundation; either
16  //version 2.1 of the License, or (at your option) any later version.
17  //
18  //This library is distributed in the hope that it will be useful,
19  //but WITHOUT ANY WARRANTY; without even the implied warranty of
20  //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21  //Lesser General Public License for more details.
22  //
23  //You should have received a copy of the GNU Lesser General Public
24  //License along with this library; if not, write to the Free Software
25  //Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26  //-----------------------------------------------------------------------
27  //
28  //$Id: Blog.java,v 1.3 2004/10/31 10:47:58 tassos Exp $
29  //
30  
31  /***
32   * Interface that keeps
33   * 
34   * @author abas
35   */
36  public interface Blog {
37  
38      /***
39       * Get the numeric blog id if the blog.
40       * 
41       * @return the blog id.
42       */
43      public int getBlogId();
44  
45      /***
46       * Get the name of the blog.
47       * 
48       * @return the name of the blog.
49       */
50      public String getName();
51  
52      /***
53       * Get the title of the blog.
54       * 
55       * @return the title of the blog.
56       */
57      public String getTitle();
58  
59      /***
60       * Get the description of the blog.
61       * 
62       * @return the description of the blog.
63       */
64      public String getDescription();
65  
66      /***
67       * Get the configuration settings for this blog.
68       * 
69       * @return the configuration of the blog.
70       */
71      public MappedConfiguration getConfiguration();
72  
73      /***
74       * Get the display-sorted list of sections of this blog
75       * 
76       * @return a list of Sections, ordered by their display list;
77       * @throws TorqueException
78       */
79      public List getSections()
80              throws TorqueException;
81  }