站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.2 API 英文版文档

ForumsModuleImpl - JBOSS Portal 2.2 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.portlet.forums.impl
Class ForumsModuleImpl

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport
      extended byorg.jboss.system.ServiceMBeanSupport
          extended byorg.jboss.portal.common.system.AbstractJBossService
              extended byorg.jboss.portal.core.modules.AbstractModule
                  extended byorg.jboss.portlet.forums.impl.ForumsModuleImpl
All Implemented Interfaces:
ForumsModule, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, org.jboss.system.Service, org.jboss.system.ServiceMBean
public class ForumsModuleImpl
extends AbstractModule
implements ForumsModule

Field Summary
 
Fields inherited from class org.jboss.portal.core.modules.AbstractModule
JNDIName
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport
server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from interface org.jboss.system.ServiceMBean
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
ForumsModuleImpl()
           
 
Method Summary
 void addAllForums(Category source, Category target)
          DOCUMENT_ME
 Poll addPollToTopic(Topic topic, Poll poll)
          DOCUMENT_ME
 Category createCategory(java.lang.String name)
          DOCUMENT_ME
 Forum createForum(Category category, java.lang.String name, java.lang.String description)
          DOCUMENT_ME
 Post createPost(Topic topic, Forum forum, Message message, java.util.Date creationDate, Poster poster, java.util.List attachments)
          DOCUMENT_ME
 Poster createPoster(java.lang.String userId)
           
 Post createTopic(Forum forum, Message message, java.util.Date creationDate, Poster poster, Poll poll, java.util.List attachments, int type)
          DOCUMENT_ME
 Topic createTopic(Forum forum, java.lang.String userId, java.lang.String subject, int type)
          DOCUMENT_ME
 void createWatch(Poster poster, Forum forum, int mode)
           
 void createWatch(Poster poster, Topic topic)
           
 java.util.List findAnnouncements(Forum forum)
          Returns all the announcements of the forum
 java.util.List findCategories()
          Get all the categories of forums.
 Category findCategoryById(java.lang.Integer id)
          DOCUMENT_ME
 Attachment findFindAttachmentById(java.lang.Integer attachID)
           
 Post findFirstPost(Topic topic)
           
 Forum findForumById(java.lang.Integer id)
          Find a forum by specifying its ID
 java.util.List findForums()
          DOCUMENT_ME
 java.util.List findForumsByCategoryId(java.lang.Integer categoryId)
          Get all the forums of a category
 ForumWatch findForumWatchById(java.lang.Integer forumWatchId)
           
 java.util.List findForumWatchByUser(User user)
           
 Post findLastPost(Forum forum)
           
 Post findLastPost(Topic topic)
           
 java.util.Date findLastPostDateForUser(User user)
           
 Post findPostById(java.lang.Integer id)
          DOCUMENT_ME
 Poster findPosterByUserId(java.lang.String userId)
          DOCUMENT_ME
 java.util.List findPosts()
          DOCUMENT_ME
 java.util.List findPostsByTopicId(java.lang.Integer topicId)
          DOCUMENT_ME
 java.util.List findPostsByTopicIdAsc(java.lang.Integer topicId, int start, int limit)
          DOCUMENT_ME
 java.util.List findPostsByTopicIdDesc(java.lang.Integer topicId, int start, int limit)
          DOCUMENT_ME
 Topic findTopicById(java.lang.Integer id)
           
 java.util.List findTopics()
          Returns some topics of a forum that are not of a certain type
 java.util.List findTopics(Forum forum)
          *
 java.util.List findTopicsAsc(Forum forum, int type, int start, int perPage)
          Returns some topics of a forum that are not of a certain type The topics are ordered by creation date from oldest to newest
 java.util.List findTopicsBefore(Forum forum, int type, int start, int perPage, java.util.Date date)
          DOCUMENT_ME
 java.util.List findTopicsByLatestPosts(int limit)
          DOCUMENT_ME
 java.util.List findTopicsDesc(Forum forum, int type, int start, int perPage)
          Returns some topics of a forum that are not of a certain type The topics are ordered by creation date from newest to oldest
 java.util.List findTopicsHot(int replies, int limit)
          DOCUMENT_ME
 java.util.List findTopicsHottest(java.util.Date after, int limit)
          DOCUMENT_ME
 java.util.List findTopicsMostViewed(java.util.Date after, int limit)
          DOCUMENT_ME
 TopicWatch findTopicWatchById(java.lang.Integer topicWatchId)
           
 int getFloodInterval()
           
 java.lang.String getFromAddress()
           
 HibernateProvider getHibernate()
           
 Result invoke(ActionCommand cmd)
           
 void removeCategory(Category category)
          DOCUMENT_ME
 void removeForum(Forum forum)
          DOCUMENT_ME
 void removePollInTopic(Topic topic)
          Delete a post
 void removePost(Post post)
          Delete a post
 void removeTopic(Topic topic)
          Delete a topic
 void removeWatch(Watch watch)
           
 void setFloodInterval(int floodInterval)
           
 void setFromAddress(java.lang.String fromAddress)
           
 void setHibernate(HibernateProvider hibernate)
           
protected  void startService()
           
 
Methods inherited from class org.jboss.portal.core.modules.AbstractModule
getJNDIName, setJNDIName, stopService
 
Methods inherited from class org.jboss.portal.common.system.AbstractJBossService
create, destroy, getState, getStateString, start, stop
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport
createService, destroyService, getDeploymentInfo, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport
addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ForumsModuleImpl

public ForumsModuleImpl()
Method Detail

startService

protected void startService()
                     throws java.lang.Exception
Overrides:
startService in class AbstractModule
Throws:
java.lang.Exception

getHibernate

public HibernateProvider getHibernate()
Specified by:
getHibernate in interface ForumsModule

setHibernate

public void setHibernate(HibernateProvider hibernate)

getFloodInterval

public int getFloodInterval()
Specified by:
getFloodInterval in interface ForumsModule

setFloodInterval

public void setFloodInterval(int floodInterval)
Specified by:
setFloodInterval in interface ForumsModule

getFromAddress

public java.lang.String getFromAddress()
Specified by:
getFromAddress in interface ForumsModule

setFromAddress

public void setFromAddress(java.lang.String fromAddress)
Specified by:
setFromAddress in interface ForumsModule

findForumById

public Forum findForumById(java.lang.Integer id)
                    throws ModuleException
Description copied from interface: ForumsModule
Find a forum by specifying its ID

Specified by:
findForumById in interface ForumsModule
Parameters:
id - ID of the forum to retrieve
Returns:
Forum with specified ID
Throws:
ModuleException - Throws an exception if the forum cannot be found

findCategoryById

public Category findCategoryById(java.lang.Integer id)
                          throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findCategoryById in interface ForumsModule
Parameters:
id - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findPosterByUserId

public Poster findPosterByUserId(java.lang.String userId)
                          throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findPosterByUserId in interface ForumsModule
Parameters:
userId - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

createPoster

public Poster createPoster(java.lang.String userId)
                    throws ModuleException
Specified by:
createPoster in interface ForumsModule
Throws:
ModuleException

findCategories

public java.util.List findCategories()
                              throws ModuleException
Description copied from interface: ForumsModule
Get all the categories of forums.

Specified by:
findCategories in interface ForumsModule
Returns:
All the categories
Throws:
ModuleException

findForums

public java.util.List findForums()
                          throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findForums in interface ForumsModule
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findForumsByCategoryId

public java.util.List findForumsByCategoryId(java.lang.Integer categoryId)
                                      throws ModuleException
Description copied from interface: ForumsModule
Get all the forums of a category

Specified by:
findForumsByCategoryId in interface ForumsModule
Parameters:
categoryId - Category of forums
Returns:
Forums of one category
Throws:
ModuleException

findAnnouncements

public java.util.List findAnnouncements(Forum forum)
                                 throws ModuleException
Description copied from interface: ForumsModule
Returns all the announcements of the forum

Specified by:
findAnnouncements in interface ForumsModule
Parameters:
forum - Forum in which we want to search for the announcements
Returns:
List of topics
Throws:
ModuleException - Throws an exception if unable to find the announcements.

findTopics

public java.util.List findTopics()
                          throws ModuleException
Description copied from interface: ForumsModule
Returns some topics of a forum that are not of a certain type

Specified by:
findTopics in interface ForumsModule
Returns:
List of topics
Throws:
ModuleException - Throws an excpetion if unable to find the topics.

findTopicsAsc

public java.util.List findTopicsAsc(Forum forum,
                                    int type,
                                    int start,
                                    int perPage)
                             throws ModuleException
Description copied from interface: ForumsModule
Returns some topics of a forum that are not of a certain type The topics are ordered by creation date from oldest to newest

Specified by:
findTopicsAsc in interface ForumsModule
Parameters:
forum - Forum in which we want to search for topics
type - Type to avoid
start - Index for fetching result
perPage - Number of result to return
Returns:
List of perPage topics ordered by creation date.
Throws:
ModuleException - Throws an excpetion if unable to find the topics.

findTopicsDesc

public java.util.List findTopicsDesc(Forum forum,
                                     int type,
                                     int start,
                                     int perPage)
                              throws ModuleException
Description copied from interface: ForumsModule
Returns some topics of a forum that are not of a certain type The topics are ordered by creation date from newest to oldest

Specified by:
findTopicsDesc in interface ForumsModule
Parameters:
forum - Forum in which we want to search for topics
type - Type to avoid
start - Index for fetching result
perPage - Number of result to return
Returns:
List of perPage topics ordered by opposite creation date.
Throws:
ModuleException - Throws an excpetion if unable to find the topics.

findTopicsBefore

public java.util.List findTopicsBefore(Forum forum,
                                       int type,
                                       int start,
                                       int perPage,
                                       java.util.Date date)
                                throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findTopicsBefore in interface ForumsModule
Parameters:
forum - DOCUMENT_ME
type - DOCUMENT_ME
start - DOCUMENT_ME
perPage - DOCUMENT_ME
date - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findTopicsHot

public java.util.List findTopicsHot(int replies,
                                    int limit)
                             throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findTopicsHot in interface ForumsModule
Parameters:
replies - DOCUMENT_ME
limit - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findTopicsByLatestPosts

public java.util.List findTopicsByLatestPosts(int limit)
                                       throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findTopicsByLatestPosts in interface ForumsModule
Parameters:
limit - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findTopicsHottest

public java.util.List findTopicsHottest(java.util.Date after,
                                        int limit)
                                 throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findTopicsHottest in interface ForumsModule
Parameters:
after - DOCUMENT_ME
limit - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findTopicsMostViewed

public java.util.List findTopicsMostViewed(java.util.Date after,
                                           int limit)
                                    throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findTopicsMostViewed in interface ForumsModule
Parameters:
after - DOCUMENT_ME
limit - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

createTopic

public Post createTopic(Forum forum,
                        Message message,
                        java.util.Date creationDate,
                        Poster poster,
                        Poll poll,
                        java.util.List attachments,
                        int type)
                 throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
createTopic in interface ForumsModule
Parameters:
forum - DOCUMENT_ME
message - DOCUMENT_ME
creationDate - DOCUMENT_ME
poster - DOCUMENT_ME
Returns:
The new post created
Throws:
ModuleException - DOCUMENT_ME

createTopic

public Topic createTopic(Forum forum,
                         java.lang.String userId,
                         java.lang.String subject,
                         int type)
                  throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
createTopic in interface ForumsModule
Parameters:
forum - DOCUMENT_ME
userId - DOCUMENT_ME
subject - DOCUMENT_ME
type - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

createPost

public Post createPost(Topic topic,
                       Forum forum,
                       Message message,
                       java.util.Date creationDate,
                       Poster poster,
                       java.util.List attachments)
                throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
createPost in interface ForumsModule
Parameters:
topic - DOCUMENT_ME
forum - DOCUMENT_ME
message - DOCUMENT_ME
creationDate - DOCUMENT_ME
poster - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

addPollToTopic

public Poll addPollToTopic(Topic topic,
                           Poll poll)
                    throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
addPollToTopic in interface ForumsModule
Parameters:
topic - DOCUMENT_ME
poll - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

createCategory

public Category createCategory(java.lang.String name)
                        throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
createCategory in interface ForumsModule
Parameters:
name - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

removeCategory

public void removeCategory(Category category)
                    throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
removeCategory in interface ForumsModule
Parameters:
category - DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

removeForum

public void removeForum(Forum forum)
                 throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
removeForum in interface ForumsModule
Parameters:
forum - DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

removePost

public void removePost(Post post)
                throws ModuleException
Description copied from interface: ForumsModule
Delete a post

Specified by:
removePost in interface ForumsModule
Parameters:
post - Post to delete
Throws:
ModuleException - DOCUMENT_ME

removePollInTopic

public void removePollInTopic(Topic topic)
                       throws ModuleException
Description copied from interface: ForumsModule
Delete a post

Specified by:
removePollInTopic in interface ForumsModule
Parameters:
topic - Post to delete
Throws:
ModuleException - DOCUMENT_ME

removeTopic

public void removeTopic(Topic topic)
                 throws ModuleException
Description copied from interface: ForumsModule
Delete a topic

Specified by:
removeTopic in interface ForumsModule
Parameters:
topic - Topic to delete
Throws:
ModuleException - DOCUMENT_ME

createForum

public Forum createForum(Category category,
                         java.lang.String name,
                         java.lang.String description)
                  throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
createForum in interface ForumsModule
Parameters:
category - DOCUMENT_ME
name - DOCUMENT_ME
description - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findTopicById

public Topic findTopicById(java.lang.Integer id)
                    throws ModuleException
Specified by:
findTopicById in interface ForumsModule
Parameters:
id -
Returns:
DOCUMENT_ME
Throws:
ModuleException

findTopics

public java.util.List findTopics(Forum forum)
                          throws ModuleException
Description copied from interface: ForumsModule
*

Specified by:
findTopics in interface ForumsModule
Parameters:
forum - Forum in which we want to search for topics
Returns:
List of perPage topics ordered by creation date.
Throws:
ModuleException - Throws an excpetion if unable to find the topics.

findPosts

public java.util.List findPosts()
                         throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findPosts in interface ForumsModule
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findPostById

public Post findPostById(java.lang.Integer id)
                  throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findPostById in interface ForumsModule
Parameters:
id - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findFindAttachmentById

public Attachment findFindAttachmentById(java.lang.Integer attachID)
                                  throws ModuleException
Specified by:
findFindAttachmentById in interface ForumsModule
Throws:
ModuleException

findPostsByTopicId

public java.util.List findPostsByTopicId(java.lang.Integer topicId)
                                  throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findPostsByTopicId in interface ForumsModule
Parameters:
topicId - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

addAllForums

public void addAllForums(Category source,
                         Category target)
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
addAllForums in interface ForumsModule
Parameters:
source - DOCUMENT_ME
target - DOCUMENT_ME

findPostsByTopicIdAsc

public java.util.List findPostsByTopicIdAsc(java.lang.Integer topicId,
                                            int start,
                                            int limit)
                                     throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findPostsByTopicIdAsc in interface ForumsModule
Parameters:
topicId - DOCUMENT_ME
start - DOCUMENT_ME
limit - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findPostsByTopicIdDesc

public java.util.List findPostsByTopicIdDesc(java.lang.Integer topicId,
                                             int start,
                                             int limit)
                                      throws ModuleException
Description copied from interface: ForumsModule
DOCUMENT_ME

Specified by:
findPostsByTopicIdDesc in interface ForumsModule
Parameters:
topicId - DOCUMENT_ME
start - DOCUMENT_ME
limit - DOCUMENT_ME
Returns:
DOCUMENT_ME
Throws:
ModuleException - DOCUMENT_ME

findLastPostDateForUser

public java.util.Date findLastPostDateForUser(User user)
                                       throws ModuleException
Specified by:
findLastPostDateForUser in interface ForumsModule
Throws:
ModuleException

findLastPost

public Post findLastPost(Forum forum)
                  throws ModuleException
Specified by:
findLastPost in interface ForumsModule
Throws:
ModuleException

findFirstPost

public Post findFirstPost(Topic topic)
                   throws ModuleException
Specified by:
findFirstPost in interface ForumsModule
Throws:
ModuleException

findLastPost

public Post findLastPost(Topic topic)
                  throws ModuleException
Specified by:
findLastPost in interface ForumsModule
Throws:
ModuleException

findForumWatchByUser

public java.util.List findForumWatchByUser(User user)
                                    throws ModuleException
Specified by:
findForumWatchByUser in interface ForumsModule
Throws:
ModuleException

createWatch

public void createWatch(Poster poster,
                        Forum forum,
                        int mode)
                 throws ModuleException
Specified by:
createWatch in interface ForumsModule
Parameters:
poster -
forum -
mode -
Throws:
ModuleException

removeWatch

public void removeWatch(Watch watch)
                 throws ModuleException
Specified by:
removeWatch in interface ForumsModule
Parameters:
watch -
Throws:
ModuleException

findForumWatchById

public ForumWatch findForumWatchById(java.lang.Integer forumWatchId)
                              throws ModuleException
Specified by:
findForumWatchById in interface ForumsModule
Parameters:
forumWatchId -
Returns:
DOCUMENT_ME
Throws:
ModuleException

createWatch

public void createWatch(Poster poster,
                        Topic topic)
                 throws ModuleException
Specified by:
createWatch in interface ForumsModule
Parameters:
poster -
topic -
Throws:
ModuleException

findTopicWatchById

public TopicWatch findTopicWatchById(java.lang.Integer topicWatchId)
                              throws ModuleException
Specified by:
findTopicWatchById in interface ForumsModule
Parameters:
topicWatchId -
Returns:
DOCUMENT_ME
Throws:
ModuleException

invoke

public Result invoke(ActionCommand cmd)
              throws CommandException
Specified by:
invoke in interface ForumsModule
Parameters:
cmd -
Returns:
Throws:
CommandException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD