com.webmethods.caf.faces.data.comments
Interface ICommentsListProvider

All Known Implementing Classes:

CommentsListProvider, TaskCommentsListProvider

public interface ICommentsListProvider

Interface representing operations over comments list

Method Summary

String	addComment(String text, boolean isHtml, List attachments) Adds new comment
boolean	canCreateComment() If current user could create new comments
boolean	canDeleteComment(String commentID) If current user could delete specific comment
boolean	canUpdateComment(String commentID) If current user could update specific comment
void	deleteComment(String commentID) Deletes specified comment
ICommentEntry[]	getCommentsList() Returns list of all comments
String	getContainerID() Returns containerID for the comments list
void	refresh() Refreshes content of the provider
void	setContainerID(String containerID) Sets containerID for this comments list
void	updateComment(String commendID, String text, List attachments, List deleteAttachments) Updates an existing comment

Method Detail

getContainerID

String getContainerID()

Returns containerID for the comments list

setContainerID

void setContainerID(String containerID)
                    throws Exception

Sets containerID for this comments list

Throws:

Exception

canCreateComment

boolean canCreateComment()
                         throws Exception

If current user could create new comments

Throws:

Exception

canDeleteComment

boolean canDeleteComment(String commentID)
                         throws Exception

If current user could delete specific comment

Throws:

Exception

canUpdateComment

boolean canUpdateComment(String commentID)
                         throws Exception

If current user could update specific comment

Throws:

Exception

getCommentsList

ICommentEntry[] getCommentsList()
                                throws Exception

Returns list of all comments

Throws:

Exception

deleteComment

void deleteComment(String commentID)
                   throws Exception

Deletes specified comment

Throws:

Exception

addComment

String addComment(String text,
                  boolean isHtml,
                  List attachments)
                  throws Exception

Adds new comment

Parameters:

text - comment text

isHtml - if text is in HTML format

attachments - list of attachments

Returns:

commentID

Throws:

Exception

updateComment

void updateComment(String commendID,
                   String text,
                   List attachments,
                   List deleteAttachments)
                   throws Exception

Updates an existing comment

Parameters:

commendID - commentID to update

text - new text for comment

attachments - list of new or updates attachments

deleteAttachments - list of deleted attachments (by name)

Throws:

Exception

refresh

void refresh()

Refreshes content of the provider