Package org.silverpeas.components.forums.service

Interface ForumService

All Known Implementing Classes:

DefaultForumService

public interface ForumService

Forums service layer interface

Author:

frageade

Method Summary

Modifier and Type	Method	Description
void	addModerator(ForumPK forumPK, String userId)
String	createCategory(org.silverpeas.core.node.model.NodeDetail category)
int	createForum(ForumPK forumPK, String forumName, String forumDescription, String forumCreator, int forumParent, String categoryId, String keywords)
void	createIndex(ForumPK forumPK)
void	createIndex(MessagePK messagePK)
int	createMessage(MessagePK messagePK, String messageTitle, String messageAuthor, Date messageCreationdate, int messageForum, int messageParent, String messageText, String keywords, String status)
void	deleteAll(String instanceId)
void	deleteCategory(String categoryId, String instanceId)
void	deleteForum(ForumPK forumPK)
void	deleteMessage(MessagePK messagePK)
static ForumService	get()
Collection<org.silverpeas.core.node.model.NodeDetail>	getAllCategories(String instanceId)
int	getAuthorNbMessages(String userId, String status)
org.silverpeas.core.node.model.NodeDetail	getCategory(org.silverpeas.core.node.model.NodePK nodePK)
Forum	getForum(ForumPK forumPK)
ForumDetail	getForumDetail(ForumPK forumPK)
String	getForumInstanceId(int forumId)
String	getForumName(int forumId)
int	getForumParentId(int forumId)
ForumPath	getForumPath(ForumPK forumPK)
Collection<Forum>	getForumRootList(String instanceId)
Collection<ForumDetail>	getForums(Collection<ForumPK> forumPKs)
List<Forum>	getForums(ForumPK forumPK)
List<Forum>	getForumsByCategory(ForumPK forumPK, String categoryId)
Collection<Forum>	getForumsList(Collection<ForumPK> forumPKs)
List<String>	getForumSonsIds(ForumPK forumPK)
String	getForumTags(ForumPK forumPK)
Message	getLastMessage(ForumPK forumPK, int messageParentId, String status)
Message	getLastMessage(ForumPK forumPK, String status)
Message	getLastMessage(ForumPK forumPK, List<String> messageParentId, String status)
Collection	getLastMessageRSS(String instanceId, int nbReturned)
Collection<Message>	getLastThreads(ForumPK forumPK, int count)
Message	getMessage(MessagePK messagePK)
int	getMessageParentId(int messageId)
MessagePath	getMessagePath(MessagePK messagePK)
Collection<Message>	getMessages(ForumPK forumPK)
String	getMessageTags(MessagePK messagePK)
String	getMessageTitle(int messageId)
List<Moderator>	getModerators(int forumId)
int	getNbMessages(int forumId, String type, String status)
int	getNbResponses(int forumId, int messageId, String status)
Collection<Message>	getNotAnsweredLastThreads(ForumPK forumPK, int count)
int	getSilverObjectId(ForumPK forumPK)
Collection<Message>	getThreadsList(Collection<MessagePK> messagePKs)
boolean	isForumActive(int forumId)
boolean	isModerator(String userId, ForumPK forumPK)
boolean	isNewMessage(String userId, ForumPK forumPK, int messageId, String status)
boolean	isNewMessageByForum(String userId, ForumPK forumPK, String status)
boolean	isSubscriber(String instanceId, String userId)
boolean	isSubscriber(ForumPK forumPK, String userId)
boolean	isSubscriber(MessagePK messagePK, String userId)
boolean	isSubscriberByInheritance(ForumPK forumPK, String userId)
boolean	isSubscriberByInheritance(MessagePK messagePK, String userId)
org.silverpeas.core.subscription.util.SubscriptionSubscriberList	listAllSubscribers(String instanceId)
org.silverpeas.core.subscription.util.SubscriptionSubscriberList	listAllSubscribers(ForumPK forumPK)
org.silverpeas.core.subscription.util.SubscriptionSubscriberList	listAllSubscribers(MessagePK messagePK)
void	lockForum(ForumPK forumPK, int level)
void	moveMessage(MessagePK messagePK, ForumPK forumPK)
void	removeAllModerators(ForumPK forumPK)
void	removeModerator(ForumPK forumPK, String userId)
void	setLastVisit(String userId, int messageId)
void	subscribeForum(ForumPK forumPK, String userId)
void	subscribeMessage(MessagePK messagePK, String userId)
int	unlockForum(ForumPK forumPK, int level)
void	unsubscribeForum(ForumPK forumPK, String userId)
void	unsubscribeMessage(MessagePK messagePK, String userId)
void	updateCategory(org.silverpeas.core.node.model.NodeDetail category)
void	updateForum(ForumPK forumPK, String forumName, String forumDescription, int forumParent, String categoryId, String keywords)
void	updateMessage(MessagePK messagePK, String title, String message, String userId, String status)
void	updateMessageKeywords(MessagePK messagePK, String keywords)

Method Detail

get

static ForumService get()

getForum

Forum getForum(ForumPK forumPK)

getForumPath

ForumPath getForumPath(ForumPK forumPK)

getForumName

String getForumName(int forumId)

deleteAll

void deleteAll(String instanceId)

isForumActive

boolean isForumActive(int forumId)

getForumParentId

int getForumParentId(int forumId)

getForumInstanceId

String getForumInstanceId(int forumId)

getForums

Collection<ForumDetail> getForums(Collection<ForumPK> forumPKs)

getForumDetail

ForumDetail getForumDetail(ForumPK forumPK)

Parameters:

forumPK - forum primary key

Returns:

a ForumDetail from the forum primary key identifier

getForumRootList

Collection<Forum> getForumRootList(String instanceId)

getForumsList

Collection<Forum> getForumsList(Collection<ForumPK> forumPKs)

getThreadsList

Collection<Message> getThreadsList(Collection<MessagePK> messagePKs)

getForums

List<Forum> getForums(ForumPK forumPK)

getForumsByCategory

List<Forum> getForumsByCategory(ForumPK forumPK,
                                String categoryId)

getForumSonsIds

List<String> getForumSonsIds(ForumPK forumPK)

createForum

int createForum(ForumPK forumPK,
                String forumName,
                String forumDescription,
                String forumCreator,
                int forumParent,
                String categoryId,
                String keywords)

updateForum

void updateForum(ForumPK forumPK,
                 String forumName,
                 String forumDescription,
                 int forumParent,
                 String categoryId,
                 String keywords)

lockForum

void lockForum(ForumPK forumPK,
               int level)

unlockForum

int unlockForum(ForumPK forumPK,
                int level)

deleteForum

void deleteForum(ForumPK forumPK)

getMessages

Collection<Message> getMessages(ForumPK forumPK)

getMessage

Message getMessage(MessagePK messagePK)

getMessagePath

MessagePath getMessagePath(MessagePK messagePK)

getMessageTitle

String getMessageTitle(int messageId)

getMessageParentId

int getMessageParentId(int messageId)

getLastMessage

Message getLastMessage(ForumPK forumPK,
                       String status)

getLastMessage

Message getLastMessage(ForumPK forumPK,
                       int messageParentId,
                       String status)

getLastMessage

Message getLastMessage(ForumPK forumPK,
                       List<String> messageParentId,
                       String status)

getLastMessageRSS

Collection getLastMessageRSS(String instanceId,
                             int nbReturned)

getNbMessages

int getNbMessages(int forumId,
                  String type,
                  String status)

getAuthorNbMessages

int getAuthorNbMessages(String userId,
                        String status)

getNbResponses

int getNbResponses(int forumId,
                   int messageId,
                   String status)

isNewMessageByForum

boolean isNewMessageByForum(String userId,
                            ForumPK forumPK,
                            String status)

isNewMessage

boolean isNewMessage(String userId,
                     ForumPK forumPK,
                     int messageId,
                     String status)

setLastVisit

void setLastVisit(String userId,
                  int messageId)

createMessage

int createMessage(MessagePK messagePK,
                  String messageTitle,
                  String messageAuthor,
                  Date messageCreationdate,
                  int messageForum,
                  int messageParent,
                  String messageText,
                  String keywords,
                  String status)

updateMessage

void updateMessage(MessagePK messagePK,
                   String title,
                   String message,
                   String userId,
                   String status)

updateMessageKeywords

void updateMessageKeywords(MessagePK messagePK,
                           String keywords)

deleteMessage

void deleteMessage(MessagePK messagePK)

isModerator

boolean isModerator(String userId,
                    ForumPK forumPK)

addModerator

void addModerator(ForumPK forumPK,
                  String userId)

removeModerator

void removeModerator(ForumPK forumPK,
                     String userId)

removeAllModerators

void removeAllModerators(ForumPK forumPK)

getModerators

List<Moderator> getModerators(int forumId)

moveMessage

void moveMessage(MessagePK messagePK,
                 ForumPK forumPK)

subscribeMessage

void subscribeMessage(MessagePK messagePK,
                      String userId)

unsubscribeMessage

void unsubscribeMessage(MessagePK messagePK,
                        String userId)

subscribeForum

void subscribeForum(ForumPK forumPK,
                    String userId)

unsubscribeForum

void unsubscribeForum(ForumPK forumPK,
                      String userId)

listAllSubscribers

org.silverpeas.core.subscription.util.SubscriptionSubscriberList listAllSubscribers(MessagePK messagePK)

listAllSubscribers

org.silverpeas.core.subscription.util.SubscriptionSubscriberList listAllSubscribers(ForumPK forumPK)

listAllSubscribers

org.silverpeas.core.subscription.util.SubscriptionSubscriberList listAllSubscribers(String instanceId)

isSubscriber

boolean isSubscriber(MessagePK messagePK,
                     String userId)

isSubscriberByInheritance

boolean isSubscriberByInheritance(MessagePK messagePK,
                                  String userId)

isSubscriber

boolean isSubscriber(ForumPK forumPK,
                     String userId)

isSubscriberByInheritance

boolean isSubscriberByInheritance(ForumPK forumPK,
                                  String userId)

isSubscriber

boolean isSubscriber(String instanceId,
                     String userId)

createIndex

void createIndex(ForumPK forumPK)

createIndex

void createIndex(MessagePK messagePK)

getSilverObjectId

int getSilverObjectId(ForumPK forumPK)

createCategory

String createCategory(org.silverpeas.core.node.model.NodeDetail category)

deleteCategory

void deleteCategory(String categoryId,
                    String instanceId)

updateCategory

void updateCategory(org.silverpeas.core.node.model.NodeDetail category)

getCategory

org.silverpeas.core.node.model.NodeDetail getCategory(org.silverpeas.core.node.model.NodePK nodePK)

getAllCategories

Collection<org.silverpeas.core.node.model.NodeDetail> getAllCategories(String instanceId)

getForumTags

String getForumTags(ForumPK forumPK)

getMessageTags

String getMessageTags(MessagePK messagePK)

getLastThreads

Collection<Message> getLastThreads(ForumPK forumPK,
                                   int count)

getNotAnsweredLastThreads

Collection<Message> getNotAnsweredLastThreads(ForumPK forumPK,
                                              int count)