Board

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> RuntimeCollective >> bboard >> [ bean overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.RuntimeCollective.bboard.bean.Board

SOURCE |

Download com.RuntimeCollective.bboard.bean.Board

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.RuntimeCollective.bboard.bean
Interface Board

All Superinterfaces:: com.RuntimeCollective.content.bean.Content, com.RuntimeCollective.webapps.bean.Duplicable, com.RuntimeCollective.webapps.bean.EntityBean, com.RuntimeCollective.webapps.bean.PermissionBean, java.io.Serializable

All Known Subinterfaces:: Blog, Faq, Help

All Known Implementing Classes:: SimpleBlog, SimpleBoard, SimpleFaq, SimpleHelp

public interface Board
extends com.RuntimeCollective.content.bean.Content, com.RuntimeCollective.webapps.bean.PermissionBean

An interface that defines a bulletin board.

If you want to be spared the hassle of writing JSPs for the creation of your Board objects, do have a look at the pages written for the Sussex Enterprise project. You can find them by checking out the relevent project: "cvs co rsework", then look in rsework/web and in rsework/web/admin.

The pages are called add/edit/delete(Message)BoardXXX.jsp. They should be pretty self-explanatory. The rsework/struts-config.xml file is also worth checking, for the action mappings etc.

And while you're at it, why not vanilla them and copy them to bboard/web/admin ...

You can also check the Sussex Enterprise staging server (ask Fabrice, JoeH or Sophie).

Version:: $Id: Board.java,v 1.10 2003/09/30 15:12:43 joe Exp $

Field Summary

static java.lang.String DATABASE_TABLE
          The name of the database table for this bean type.

Fields inherited from interface com.RuntimeCollective.webapps.bean.EntityBean

INTERFACE_BEAN, NULL_ID

Method Summary

void addTopic(Topic topic)
          Add a topic to this board.

void approveAll()
          Approve all the topics and messages in that Board (only relevent if you are using moderation).

java.lang.String getDescription(java.lang.String format)
          Get the description under a given format.

Faq getFaq()
          Get the FAQ for this board.

java.util.Iterator getIndexedTopics()
          Get all the Topics for this MessageBoard, with their positions

boolean getOpen()
          Get whether this board is currently accepting new topics.

com.RuntimeCollective.bboard.TopicList getTopicList()
          Get the list of topics for this board.

com.RuntimeCollective.bboard.TopicList getTopicListByMessageDate()
          Get the list of topics for this board, ordered by message date (most recent first).

java.util.Iterator getTopics()
          Get all the Topics for this MessageBoard

boolean hasUnread(com.RuntimeCollective.webapps.bean.User user)
          Whether this board contains any topics that contain any messages that have not been read by this user.

void removeTopic(Topic topic)
          Remove a topic from this board.

void setDescription(java.lang.String description, java.lang.String format)
          Set the description under a given format.

void setOpen(boolean open)
          Set whether this board is currently accepting new topics.

Methods inherited from interface com.RuntimeCollective.content.bean.Content

getAuthor, getCreationDate, getDescription, getLastModifiedDate, getLastModifierUser, getTitle, setAuthor, setCreationDate, setDescription, setLastModifiedDate, setLastModifierUser, setTitle, viewFormat

Methods inherited from interface com.RuntimeCollective.webapps.bean.EntityBean

delete, getId, save, setId

Methods inherited from interface com.RuntimeCollective.webapps.bean.Duplicable

customiseDuplicate, makeDuplicate, makeDuplicate

Methods inherited from interface com.RuntimeCollective.webapps.bean.PermissionBean

canEdit, canView

Field Detail

DATABASE_TABLE

public static final java.lang.String DATABASE_TABLE

The name of the database table for this bean type.

See Also:: Constant Field Values

Method Detail

getOpen

public boolean getOpen()

Get whether this board is currently accepting new topics.

setOpen

public void setOpen(boolean open)

Set whether this board is currently accepting new topics. Depending on the implementation, this may also close all the topics associated with this board.

getIndexedTopics

public java.util.Iterator getIndexedTopics()

Get all the Topics for this MessageBoard, with their positions

getTopics

public java.util.Iterator getTopics()

Get all the Topics for this MessageBoard

addTopic

public void addTopic(Topic topic)

Add a topic to this board.

removeTopic

public void removeTopic(Topic topic)

Remove a topic from this board.

getTopicList

public com.RuntimeCollective.bboard.TopicList getTopicList()

Get the list of topics for this board.

getTopicListByMessageDate

public com.RuntimeCollective.bboard.TopicList getTopicListByMessageDate()

Get the list of topics for this board, ordered by message date (most recent first).

setDescription

public void setDescription(java.lang.String description,
                           java.lang.String format)

Set the description under a given format.

getDescription

public java.lang.String getDescription(java.lang.String format)

Get the description under a given format.

hasUnread

public boolean hasUnread(com.RuntimeCollective.webapps.bean.User user)

Whether this board contains any topics that contain any messages that have not been read by this user.

getFaq

public Faq getFaq()

Get the FAQ for this board.

approveAll

public void approveAll()

Approve all the topics and messages in that Board (only relevent if you are using moderation).