org.osivia.services.forum.thread.portlet.repository

Interface ForumThreadRepository

All Known Implementing Classes:

ForumThreadRepositoryImpl

public interface ForumThreadRepository

Forum thread portlet repository interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSED_PROPERTY Closed forum thread Nuxeo document property.

Method Summary

Methods

Modifier and Type	Method and Description
ForumThreadObject	createPost(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, ForumThreadForm form, ForumThreadOptions options) Create forum thread post.
void	deletePost(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, ForumThreadForm form, ForumThreadOptions options) Delete forum thread post.
net.sf.json.JSONArray	getPosts(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, org.nuxeo.ecm.automation.client.model.Document thread) Get forum thread posts JSON array.
org.nuxeo.ecm.automation.client.model.Document	getThread(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get forum thread Nuxeo document.
void	insertMenubarItems(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, org.nuxeo.ecm.automation.client.model.Document document) Insert menubar items.
boolean	isClosed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, org.nuxeo.ecm.automation.client.model.Document thread) Check if forum thread is closed.
void	setProperties(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, ForumThreadForm form) Set forum thread form properties.
org.nuxeo.ecm.automation.client.model.Document	toggleThreadClosure(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, org.nuxeo.ecm.automation.client.model.Document thread, boolean close) Toggle forum thread closure.
ForumThreadObject	updatePost(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, ForumThreadObject post, ForumThreadOptions options) Update forum thread post.

Field Detail

CLOSED_PROPERTY

static final String CLOSED_PROPERTY

Closed forum thread Nuxeo document property.

See Also:

Constant Field Values

Method Detail

insertMenubarItems

void insertMenubarItems(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                      org.nuxeo.ecm.automation.client.model.Document document)
                        throws javax.portlet.PortletException

Insert menubar items.

Parameters:

portalControllerContext - portal controller context

document - forum thread Nuxeo document

Throws:

javax.portlet.PortletException

isClosed

boolean isClosed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
               org.nuxeo.ecm.automation.client.model.Document thread)
                 throws javax.portlet.PortletException

Check if forum thread is closed.

Parameters:

portalControllerContext - portal controller context

thread - forum thread Nuxeo document

Returns:

true if forum thread is closed

Throws:

javax.portlet.PortletException

updatePost

ForumThreadObject updatePost(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                           ForumThreadObject post,
                           ForumThreadOptions options)
                             throws javax.portlet.PortletException,
                                    IOException

Update forum thread post.

Parameters:

portalControllerContext - portal controller context

post - forum thread post

options - forum thread options

Returns:

updated forum thread post

Throws:

javax.portlet.PortletException

IOException

deletePost

void deletePost(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
              ForumThreadForm form,
              ForumThreadOptions options)
                throws javax.portlet.PortletException

Delete forum thread post.

Parameters:

portalControllerContext - portal controller context

form - forum thread form

options - forum thread options

Throws:

javax.portlet.PortletException

createPost

ForumThreadObject createPost(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                           ForumThreadForm form,
                           ForumThreadOptions options)
                             throws javax.portlet.PortletException,
                                    IOException

Create forum thread post.

Parameters:

portalControllerContext - portal controller context

form - forum thread form

options - thread form options

Returns:

created forum thread post

Throws:

javax.portlet.PortletException

IOException

toggleThreadClosure

org.nuxeo.ecm.automation.client.model.Document toggleThreadClosure(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                                                 org.nuxeo.ecm.automation.client.model.Document thread,
                                                                 boolean close)
                                                                   throws javax.portlet.PortletException

Toggle forum thread closure.

Parameters:

portalControllerContext - portal controller context

thread - forum thread Nuxeo document

close - closure indicator

Returns:

updated forum thread Nuxeo document

Throws:

javax.portlet.PortletException

setProperties

void setProperties(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                 ForumThreadForm form)
                   throws javax.portlet.PortletException,
                          IOException

Set forum thread form properties.

Parameters:

portalControllerContext - portal controller context

form - forum thread form

Throws:

javax.portlet.PortletException

IOException

getThread

org.nuxeo.ecm.automation.client.model.Document getThread(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                                         throws javax.portlet.PortletException

Get forum thread Nuxeo document.

Parameters:

portalControllerContext - portal controller context

Returns:

Nuxeo document

Throws:

javax.portlet.PortletException

getPosts

net.sf.json.JSONArray getPosts(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                             org.nuxeo.ecm.automation.client.model.Document thread)
                               throws javax.portlet.PortletException,
                                      IOException

Get forum thread posts JSON array.

Parameters:

portalControllerContext - portal controller context.

thread - forum thread Nuxeo document

Returns:

JSON array

Throws:

javax.portlet.PortletException

IOException