CommentManagerActions (Nuxeo ECM Projects 8.1-SNAPSHOT API)

All Known Implementing Classes:

AbstractCommentManagerActionsBean, CommentManagerActionsBean
```
public interface CommentManagerActions
```
Provides comment manager related operations.

Author:

George Lefter

Field Summary

Fields
Modifier and Type Field and Description

static String CHILDREN_COMMENT_LIST

Fields
Modifier and Type	Field and Description
`static String`	`CHILDREN_COMMENT_LIST`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`addComment()` creates a new comment from
`DocumentModel`	`addComment(DocumentModel comment)` Add the given comment DocumentModel to commentableDoc.
`String`	`beginComment()`
`String`	`cancelComment()`
`String`	`createComment(DocumentModel docToComment)` Same as addComment() method but using the given document instead of currentDocument.
`String`	`deleteComment()`
`String`	`deleteComment(String commentId)`
`void`	`destroy()`
`void`	`documentChanged()` Clean all the bean's context variables.
`List<Action>`	`getActionsForComment()`
`List<Action>`	`getActionsForComment(String category)`
`List<ThreadEntry>`	`getCommentsAsThread()` Initializes uiComments with currentDocument if uiComments is null.
`List<ThreadEntry>`	`getCommentsAsThread(DocumentModel commentedDoc)` Initialize uiComments with given Document if uiComments is null.
`List<ThreadEntry>`	`getCommentsAsThreadOnDoc(DocumentModel doc)`
`boolean`	`getCommentStarted()`
`List<UIComment>`	`getLastCommentsByDate(String commentNumber)` Retrieves a given number of comments from currentDocument.
`List<UIComment>`	`getLastCommentsByDate(String commentNumber, DocumentModel commentedDoc)` Retrieves a given number of comments from the given Document.
`String`	`getNewContent()`
`boolean`	`getPrincipalIsAdmin()`
`String`	`getPrincipalName()`
`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(String newContent)`
`void`	`setSavedReplyCommentId(String savedReplyCommentId)`
`void`	`setShowCreateForm(boolean flag)`
`void`	`toggleCreateForm(javax.faces.event.ActionEvent event)`

- Field Detail
  - CHILDREN_COMMENT_LIST
```
static final String CHILDREN_COMMENT_LIST
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getActionsForComment
```
List<Action> getActionsForComment()
```
    Returns:
    
    available action for COMMENTS_ACTIONS
  - getActionsForComment
```
List<Action> getActionsForComment(String category)
```
    Returns:
    
    available action for given category
  - initialize
```
void initialize()
```
    Bean initialization method.
  - documentChanged
```
void documentChanged()
```
    Clean all the bean's context variables.
  - initComments
```
void initComments()
```
    Initializes uiComments with currentDocument.
  - initComments
```
void initComments(DocumentModel commentedDoc)
```
    Initializes uiComments with given Document.
  - getCommentsAsThread
```
List<ThreadEntry> getCommentsAsThread()
```
    Initializes uiComments with currentDocument if uiComments is null.
    
    Returns:
    
    list of ThreadEntry for currentDocument
  - getCommentsAsThread
```
List<ThreadEntry> getCommentsAsThread(DocumentModel commentedDoc)
```
    Initialize uiComments with given Document if uiComments is null.
    
    Returns:
    
    list of ThreadEntry for given Document.
  - getCommentsAsThreadOnDoc
```
List<ThreadEntry> getCommentsAsThreadOnDoc(DocumentModel doc)
```
    Returns:
    
    list of ThreadEntry for given Document.
  - beginComment
```
String beginComment()
```
  - cancelComment
```
String cancelComment()
```
  - addComment
```
String addComment()
```
    creates a new comment from
    
    Returns:
    
    null to avoid navigation
  - createComment
```
String createComment(DocumentModel docToComment)
```
    Same as addComment() method but using the given document instead of currentDocument.
    
    Returns:
    
    null to avoid navigation
  - addComment
```
DocumentModel addComment(DocumentModel comment)
```
    Add the given comment DocumentModel to commentableDoc.
  - deleteComment
```
String deleteComment()
```
  - deleteComment
```
String deleteComment(String commentId)
```
  - destroy
```
void destroy()
```
  - getNewContent
```
String getNewContent()
```
  - setNewContent
```
void setNewContent(String newContent)
```
  - getPrincipalName
```
String getPrincipalName()
```
  - getPrincipalIsAdmin
```
boolean getPrincipalIsAdmin()
```
  - getCommentStarted
```
boolean getCommentStarted()
```
  - getSavedReplyCommentId
```
String getSavedReplyCommentId()
```
  - setSavedReplyCommentId
```
void setSavedReplyCommentId(String savedReplyCommentId)
```
  - getShowCreateForm
```
boolean getShowCreateForm()
```
  - setShowCreateForm
```
void setShowCreateForm(boolean flag)
```
  - toggleCreateForm
```
void toggleCreateForm(javax.faces.event.ActionEvent event)
```
  - getLastCommentsByDate
```
List<UIComment> getLastCommentsByDate(String commentNumber)
```
    Retrieves a given number of comments from currentDocument.
    
    Parameters:
    
    commentNumber - the number of comment to fetch
  - getLastCommentsByDate
```
List<UIComment> getLastCommentsByDate(String commentNumber,
                                      DocumentModel commentedDoc)
```
    Retrieves a given number of comments from the given Document.
    
    Parameters:
    
    commentNumber - the number of comment to fetch
    
    commentedDoc -

Interface CommentManagerActions

Field Summary

Method Summary

Field Detail

CHILDREN_COMMENT_LIST

Method Detail

getActionsForComment

getActionsForComment

initialize

documentChanged

initComments

initComments

getCommentsAsThread

getCommentsAsThread

getCommentsAsThreadOnDoc

beginComment

cancelComment

addComment

createComment

addComment

deleteComment

deleteComment

destroy

getNewContent

setNewContent

getPrincipalName

getPrincipalIsAdmin

getCommentStarted

getSavedReplyCommentId

setSavedReplyCommentId

getShowCreateForm

setShowCreateForm

toggleCreateForm

getLastCommentsByDate

getLastCommentsByDate