org.nuxeo.ecm.platform.comment.web
Interface CommentManagerActions

All Known Implementing Classes:

AbstractCommentManagerActionsBean, CommentManagerActionsBean

public interface CommentManagerActions

Provides comment manager related operations.

Author:

George Lefter

Field Summary

static java.lang.String

CHILDREN_COMMENT_LIST

Method Summary

java.lang.String	addComment() creates a new comment from
DocumentModel	addComment(DocumentModel comment) Add the given comment DocumentModel to commentableDoc.
java.lang.String	beginComment()
java.lang.String	cancelComment()
java.lang.String	createComment(DocumentModel docToComment) Same as addComment() method but using the given document instead of currentDocument.
java.lang.String	deleteComment()
java.lang.String	deleteComment(java.lang.String commentId)
void	destroy()
void	documentChanged() Clean all the bean's context variables.
java.util.List<Action>	getActionsForComment()
java.util.List<Action>	getActionsForComment(java.lang.String category)
java.util.List<ThreadEntry>	getCommentsAsThread() Initializes uiComments with currentDocument if uiComments is null.
java.util.List<ThreadEntry>	getCommentsAsThread(DocumentModel commentedDoc) Initialize uiComments with given Document if uiComments is null.
java.util.List<ThreadEntry>	getCommentsAsThreadOnDoc(DocumentModel doc)
boolean	getCommentStarted()
java.util.List<UIComment>	getLastCommentsByDate(java.lang.String commentNumber) Retrieves a given number of comments from currentDocument.
java.util.List<UIComment>	getLastCommentsByDate(java.lang.String commentNumber, DocumentModel commentedDoc) Retrieves a given number of comments from the given Document.
java.lang.String	getNewContent()
boolean	getPrincipalIsAdmin()
java.lang.String	getPrincipalName()
java.lang.String	getSavedReplyCommentId()
boolean	getShowCreateForm()
void	initComments() Initializes uiComments with currentDocument.
void	initComments(DocumentModel commentedDoc) Initializes uiComments with given Document.
void	initialize() Bean initialization method.
void	setNewContent(java.lang.String newContent)
void	setSavedReplyCommentId(java.lang.String savedReplyCommentId)
void	setShowCreateForm(boolean flag)
void	toggleCreateForm(javax.faces.event.ActionEvent event)

Field Detail

CHILDREN_COMMENT_LIST

static final java.lang.String CHILDREN_COMMENT_LIST

See Also:

Constant Field Values

Method Detail

getActionsForComment

java.util.List<Action> getActionsForComment()

Returns:

available action for COMMENTS_ACTIONS

getActionsForComment

java.util.List<Action> getActionsForComment(java.lang.String category)

Returns:

available action for given category

initialize

void initialize()
                throws java.lang.Exception

Bean initialization method.

Throws:

java.lang.Exception

documentChanged

void documentChanged()

Clean all the bean's context variables.

initComments

void initComments()
                  throws ClientException

Initializes uiComments with currentDocument.

Throws:

ClientException

initComments

void initComments(DocumentModel commentedDoc)
                  throws ClientException

Initializes uiComments with given Document.

Throws:

ClientException

getCommentsAsThread

java.util.List<ThreadEntry> getCommentsAsThread()
                                                throws ClientException

Initializes uiComments with currentDocument if uiComments is null.

Returns:

list of ThreadEntry for currentDocument

Throws:

ClientException

getCommentsAsThread

java.util.List<ThreadEntry> getCommentsAsThread(DocumentModel commentedDoc)
                                                throws ClientException

Initialize uiComments with given Document if uiComments is null.

Returns:

list of ThreadEntry for given Document.

Throws:

ClientException

getCommentsAsThreadOnDoc

java.util.List<ThreadEntry> getCommentsAsThreadOnDoc(DocumentModel doc)
                                                     throws ClientException

Returns:

list of ThreadEntry for given Document.

Throws:

ClientException

beginComment

java.lang.String beginComment()

cancelComment

java.lang.String cancelComment()

addComment

java.lang.String addComment()
                            throws ClientException

creates a new comment from

Returns:

null to avoid navigation

Throws:

ClientException

createComment

java.lang.String createComment(DocumentModel docToComment)
                               throws ClientException

Same as addComment() method but using the given document instead of currentDocument.

Returns:

null to avoid navigation

Throws:

ClientException

addComment

DocumentModel addComment(DocumentModel comment)
                         throws ClientException

Add the given comment DocumentModel to commentableDoc.

Throws:

ClientException

deleteComment

java.lang.String deleteComment()
                               throws ClientException

Throws:

ClientException

deleteComment

java.lang.String deleteComment(java.lang.String commentId)
                               throws ClientException

Throws:

ClientException

destroy

void destroy()

getNewContent

java.lang.String getNewContent()

setNewContent

void setNewContent(java.lang.String newContent)

getPrincipalName

java.lang.String getPrincipalName()

getPrincipalIsAdmin

boolean getPrincipalIsAdmin()

getCommentStarted

boolean getCommentStarted()

getSavedReplyCommentId

java.lang.String getSavedReplyCommentId()

setSavedReplyCommentId

void setSavedReplyCommentId(java.lang.String savedReplyCommentId)

getShowCreateForm

boolean getShowCreateForm()

setShowCreateForm

void setShowCreateForm(boolean flag)

toggleCreateForm

void toggleCreateForm(javax.faces.event.ActionEvent event)

getLastCommentsByDate

java.util.List<UIComment> getLastCommentsByDate(java.lang.String commentNumber)
                                                throws ClientException

Retrieves a given number of comments from currentDocument.

Parameters:

commentNumber - the number of comment to fetch

Throws:

ClientException

getLastCommentsByDate

java.util.List<UIComment> getLastCommentsByDate(java.lang.String commentNumber,
                                                DocumentModel commentedDoc)
                                                throws ClientException

Retrieves a given number of comments from the given Document.

Parameters:

commentNumber - the number of comment to fetch

commentedDoc -

Throws:

ClientException