com.axemble.vdoc.sdk.modules

Interface IBaseForumModule

All Superinterfaces:

IModule, Remote

All Known Subinterfaces:

IForumModule

public interface IBaseForumModule
extends IModule

The forum module interface.

Code sample :

 // creation of a forum module object
 IBaseForumModule forumModule = Modules.getForumModule();
 try
 {
 }
 finally
 {
  // uninitialize the module
        Modules.releaseModule(forumModule);
 }
 

Since:

2.0

Version:

1.0, 08/01/2009

Author:

vlygeros

See Also:

IForumSpace, IForum, IDiscussion, IPost

Method Summary

Modifier and Type	Method and Description
IAttachment	addAttachment(IPost post, File ioFile)
IAttachment	addAttachment(IPost post, IAttachment attachment)
IAttachment	addAttachment(IPost post, String fileName, InputStream inputStream)
IAttachment	addAttachment(IPost post, String fileName, String fullPath)
IDiscussion	createDiscussion(IContext context, IForum forum, String label, String description)
IForum	createForum(IContext context, IForumSpace forumSpace, String label, String description)
IForum	createForum(IContext context, IForum parent, String label, String description)
IForum	createForumCategory(IContext context, IForumSpace forumSpace, String label, String description)
IForum	createForumCategory(IContext context, IForum parent, String label, String description)
IForumSpace	createForumSpace(IContext context, IOrganization organization, String name, String description) Creates a new forum area object within an organization.
IAttachment	getAttachment(IPost post, String fileName)
Collection	getAttachments(IPost post)
IDiscussion	getDiscussion(IContext context, IForum forum, String label)
IDiscussion	getDiscussion(Object object)
Collection	getDiscussions(IContext context, IForum parent)
IProtocolSupport	getElementByProtocolURI(String protocolURI) Gets an IElement object which implements IProtocolSupport interface.
IPost	getFirstPost(IContext context, IDiscussion discussion)
IForum	getForum(IContext context, IForumSpace forumSpace, String label)
IForum	getForum(IContext context, IForum parent, String label)
IForum	getForum(Object object)
IForum	getForumByPath(IContext context, IForumSpace forumSpace, String path)
Collection	getForums(IContext context, IForum parent)
Collection	getForums(IContext context, IForumSpace forumSpace)
IForumSpace	getForumSpace(IContext context, IDiscussion discussion)
IForumSpace	getForumSpace(IContext context, IForum forum)
IForumSpace	getForumSpace(IContext context, IOrganization organization, String name) Gets a forum space by its name.
IForumSpace	getForumSpace(IContext context, IPost post)
IForumSpace	getForumSpace(Object object)
Collection	getForumSpaces(IContext context) Gets all the forum spaces.
Collection	getForumSpaces(IContext context, IOrganization organization) Gets all the forum spaces within an organization.
IPost	getLastPost(IContext context, IDiscussion discussion)
IDiscussion	getParentDiscussion(IContext context, IPost post)
IForum	getParentForum(IContext context, IDiscussion discussion)
IForum	getParentForum(IContext context, IForum forum)
IForum	getParentForum(IContext context, IPost post)
Collection	getParentForums(IContext context, IDiscussion discussion)
Collection	getParentForums(IContext context, IForum forum)
Collection	getParentForums(IContext context, IPost post)
IPost	getPost(Object object)
Collection	getPosts(IContext context, IDiscussion discussion)
Collection	getPosts(IContext context, IPost parent)
ISecurityController	getSecurityController(ISecuritySupport securitySupport) Gets a security controller on a specified object.
IUser	getUser(Object object)
IUser	getUserByLogin(String login)
void	lock(IContext context, IDiscussion discussion)
void	pin(IContext context, IDiscussion discussion)
IPost	replyTo(IContext context, IDiscussion discussion, String label, String description)
IPost	replyTo(IContext context, IPost post, String label, String description)
void	unLock(IContext context, IDiscussion discussion)
void	unPin(IContext context, IDiscussion discussion)

Methods inherited from interface com.axemble.vdoc.sdk.modules.IModule

beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, findNativeClass, generateSystemName, getAnonymous, getAnonymousContext, getContext, getContext, getContextByLogin, getElementFromExternalElement, getExternalElement, getExternalElement, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getTranslation, getTranslationForLanguage, getTranslationKey, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize

Method Detail

createForumSpace

IForumSpace createForumSpace(IContext context,
                             IOrganization organization,
                             String name,
                             String description)
                      throws ForumModuleException

Creates a new forum area object within an organization.

Parameters:

context -

name -

description -

Returns:

Throws:

ForumModuleException

getForumSpace

IForumSpace getForumSpace(IContext context,
                          IOrganization organization,
                          String name)
                   throws ForumModuleException

Gets a forum space by its name.

Parameters:

context - The execution context.

organization - The IOrganization object.

name - The name of the organization.

Returns:

a IForumSpace object.

Throws:

ForumModuleException - default module exception.

getForumSpaces

Collection getForumSpaces(IContext context,
                          IOrganization organization)
                   throws ForumModuleException

Gets all the forum spaces within an organization.

Parameters:

context - The execution context.

organization - The IOrganization object.

Returns:

a Collection of IForumSpace objects.

Throws:

ForumModuleException - default module exception.

getForumSpaces

Collection getForumSpaces(IContext context)
                   throws ForumModuleException

Gets all the forum spaces.

Parameters:

context - The execution context.

Returns:

a Collection of IForumSpace objects.

Throws:

ForumModuleException - default module exception.

createForum

IForum createForum(IContext context,
                   IForumSpace forumSpace,
                   String label,
                   String description)
            throws ForumModuleException

Throws:

ForumModuleException

createForumCategory

IForum createForumCategory(IContext context,
                           IForumSpace forumSpace,
                           String label,
                           String description)
                    throws ForumModuleException

Throws:

ForumModuleException

createForum

IForum createForum(IContext context,
                   IForum parent,
                   String label,
                   String description)
            throws ForumModuleException

Throws:

ForumModuleException

createForumCategory

IForum createForumCategory(IContext context,
                           IForum parent,
                           String label,
                           String description)
                    throws ForumModuleException

Throws:

ForumModuleException

getForum

IForum getForum(IContext context,
                IForumSpace forumSpace,
                String label)
         throws ForumModuleException

Throws:

ForumModuleException

getForum

IForum getForum(IContext context,
                IForum parent,
                String label)
         throws ForumModuleException

Throws:

ForumModuleException

getForums

Collection getForums(IContext context,
                     IForum parent)
              throws ForumModuleException

Throws:

ForumModuleException

getForums

Collection getForums(IContext context,
                     IForumSpace forumSpace)
              throws ForumModuleException

Throws:

ForumModuleException

getForumByPath

IForum getForumByPath(IContext context,
                      IForumSpace forumSpace,
                      String path)
               throws ForumModuleException

Throws:

ForumModuleException

getForumSpace

IForumSpace getForumSpace(IContext context,
                          IForum forum)
                   throws ForumModuleException

Throws:

ForumModuleException

getParentForum

IForum getParentForum(IContext context,
                      IForum forum)
               throws ForumModuleException

Throws:

ForumModuleException

getParentForums

Collection getParentForums(IContext context,
                           IForum forum)
                    throws ForumModuleException

Throws:

ForumModuleException

createDiscussion

IDiscussion createDiscussion(IContext context,
                             IForum forum,
                             String label,
                             String description)
                      throws ForumModuleException

Throws:

ForumModuleException

getDiscussion

IDiscussion getDiscussion(IContext context,
                          IForum forum,
                          String label)
                   throws ForumModuleException

Throws:

ForumModuleException

getDiscussions

Collection getDiscussions(IContext context,
                          IForum parent)
                   throws ForumModuleException

Throws:

ForumModuleException

pin

void pin(IContext context,
         IDiscussion discussion)
  throws ForumModuleException

Throws:

ForumModuleException

unPin

void unPin(IContext context,
           IDiscussion discussion)
    throws ForumModuleException

Throws:

ForumModuleException

lock

void lock(IContext context,
          IDiscussion discussion)
   throws ForumModuleException

Throws:

ForumModuleException

unLock

void unLock(IContext context,
            IDiscussion discussion)
     throws ForumModuleException

Throws:

ForumModuleException

getForumSpace

IForumSpace getForumSpace(IContext context,
                          IDiscussion discussion)
                   throws ForumModuleException

Throws:

ForumModuleException

getParentForum

IForum getParentForum(IContext context,
                      IDiscussion discussion)
               throws ForumModuleException

Throws:

ForumModuleException

getParentForums

Collection getParentForums(IContext context,
                           IDiscussion discussion)
                    throws ForumModuleException

Throws:

ForumModuleException

replyTo

IPost replyTo(IContext context,
              IDiscussion discussion,
              String label,
              String description)
       throws ForumModuleException

Throws:

ForumModuleException

replyTo

IPost replyTo(IContext context,
              IPost post,
              String label,
              String description)
       throws ForumModuleException

Throws:

ForumModuleException

getFirstPost

IPost getFirstPost(IContext context,
                   IDiscussion discussion)
            throws ForumModuleException

Throws:

ForumModuleException

getLastPost

IPost getLastPost(IContext context,
                  IDiscussion discussion)
           throws ForumModuleException

Throws:

ForumModuleException

getPosts

Collection getPosts(IContext context,
                    IDiscussion discussion)
             throws ForumModuleException

Throws:

ForumModuleException

getPosts

Collection getPosts(IContext context,
                    IPost parent)
             throws ForumModuleException

Throws:

ForumModuleException

getForumSpace

IForumSpace getForumSpace(IContext context,
                          IPost post)
                   throws ForumModuleException

Throws:

ForumModuleException

getParentForum

IForum getParentForum(IContext context,
                      IPost post)
               throws ForumModuleException

Throws:

ForumModuleException

getParentDiscussion

IDiscussion getParentDiscussion(IContext context,
                                IPost post)
                         throws ForumModuleException

Throws:

ForumModuleException

getParentForums

Collection getParentForums(IContext context,
                           IPost post)
                    throws ForumModuleException

Throws:

ForumModuleException

getAttachments

Collection getAttachments(IPost post)
                   throws ForumModuleException

Throws:

ForumModuleException

getAttachment

IAttachment getAttachment(IPost post,
                          String fileName)
                   throws ForumModuleException

Throws:

ForumModuleException

addAttachment

IAttachment addAttachment(IPost post,
                          File ioFile)
                   throws ForumModuleException

Throws:

ForumModuleException

addAttachment

IAttachment addAttachment(IPost post,
                          String fileName,
                          InputStream inputStream)
                   throws ForumModuleException

Throws:

ForumModuleException

addAttachment

IAttachment addAttachment(IPost post,
                          String fileName,
                          String fullPath)
                   throws ForumModuleException

Throws:

ForumModuleException

addAttachment

IAttachment addAttachment(IPost post,
                          IAttachment attachment)
                   throws ForumModuleException

Throws:

ForumModuleException

getUserByLogin

IUser getUserByLogin(String login)

getUser

IUser getUser(Object object)
       throws ForumModuleException

Throws:

ForumModuleException

getForumSpace

IForumSpace getForumSpace(Object object)
                   throws ForumModuleException

Throws:

ForumModuleException

getForum

IForum getForum(Object object)
         throws ForumModuleException

Throws:

ForumModuleException

getDiscussion

IDiscussion getDiscussion(Object object)
                   throws ForumModuleException

Throws:

ForumModuleException

getPost

IPost getPost(Object object)
       throws ForumModuleException

Throws:

ForumModuleException

getElementByProtocolURI

IProtocolSupport getElementByProtocolURI(String protocolURI)
                                  throws ModuleException

Gets an IElement object which implements IProtocolSupport interface.

Parameters:

protocolURI - The protocol URI as a java.lang.String.

Returns:

A IProtocolSupport object.

Throws:

ModuleException - default module exception.

getSecurityController

ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                   throws ForumModuleException

Gets a security controller on a specified object.

Parameters:

securitySupport - Any IElement that implements ISecuritySupport interface.

Returns:

The ISecurityController object.

Throws:

ForumModuleException - default module exception.