Interface CockpitCommentService
- All Known Implementing Classes:
DefaultCockpitCommentService
public interface CockpitCommentService
-
Method Summary
Modifier and TypeMethodDescriptioncreateItemComment(UserModel author, ComponentModel component, CommentTypeModel type, Collection<ItemModel> items, String subject, String text) Creates and returns a new item comment.createReply(UserModel author, AbstractCommentModel comment, String text) Creates and returns a new comment reply.getComments(UserModel user, Collection<ComponentModel> components, Collection<CommentTypeModel> types, int offset, int count) Returns all comments in the specified domain components which are of the specified types and whereuseris a participant.Returns all comments in the default domain components which are of the default types and where the current user is a participant.getCurrentUserComments(org.zkoss.zk.ui.Desktop desktop) Returns all comments in the default domain components which are of the default types and where the current user is a participant.Get current user comments query.getDirectReplies(CommentModel comment, int offset, int count) Returns all direct comment replies for the specified comment.getItemComments(ItemModel item, UserModel user, Collection<ComponentModel> components, Collection<CommentTypeModel> types, int offset, int count) Gets comments.getItemCommentsQuery(ItemModel item, UserModel user, Collection<ComponentModel> components, Collection<CommentTypeModel> types) Get item comments query.getItemsFromCommentAttachments(AbstractCommentModel abstractComment) Returns all attachments of the abstract commentbooleanisRead(TypedObject commentItem) Return if the comment is read by the current user or notvoidsaveChangedComments(List<CommentModel> comments) Saves only modified comments from comments listvoidsetRead(TypedObject commentItem, boolean read) Sets the read status of the specified commentItem for the current user
-
Method Details
-
getItemComments
List<CommentModel> getItemComments(ItemModel item, UserModel user, Collection<ComponentModel> components, Collection<CommentTypeModel> types, int offset, int count) Gets comments.- Parameters:
item- the item that has been commented onuser- the authorcomponents- the related comment componentstypes- the comment typeoffset- the search offsetcount- the maximum number of comments to return- Returns:
- list of all the comments matching the specified criteria
-
getItemCommentsQuery
Query getItemCommentsQuery(ItemModel item, UserModel user, Collection<ComponentModel> components, Collection<CommentTypeModel> types) Get item comments query.- Parameters:
item- the item that has been commented onuser- the author or the watcher or the user assigned to the commentcomponents- the related comment componentstypes- the comment type- Returns:
- query for getting all comments matching the specified criteria
-
getCurrentUserCommentsQuery
Query getCurrentUserCommentsQuery()Get current user comments query.- Returns:
- query for getting all current user comments
-
createReply
Creates and returns a new comment reply.- Parameters:
author- reply authorcomment- comment to reply totext- reply content- Returns:
- created reply
-
createItemComment
CommentModel createItemComment(UserModel author, ComponentModel component, CommentTypeModel type, Collection<ItemModel> items, String subject, String text) Creates and returns a new item comment.- Parameters:
author- comment authorcomponent- comment domain componenttype- comment typeitems- related itemssubject- comment subjecttext- comment content- Returns:
- created comment
-
getDirectReplies
Returns all direct comment replies for the specified comment.- Parameters:
comment- the commentoffset- search offsetcount- max hit count- Returns:
- all found comments in the specified range
-
getComments
List<CommentModel> getComments(UserModel user, Collection<ComponentModel> components, Collection<CommentTypeModel> types, int offset, int count) Returns all comments in the specified domain components which are of the specified types and whereuseris a participant.- Parameters:
user- comment participantcomponents- domain componentstypes- comment typesoffset- search offsetcount- max hit count- Returns:
- all found comments in the specified range
-
getCurrentUserComments
List<CommentModel> getCurrentUserComments()Returns all comments in the default domain components which are of the default types and where the current user is a participant.- Returns:
- all found comments in the default range
-
getCurrentUserComments
Returns all comments in the default domain components which are of the default types and where the current user is a participant.- Returns:
- all found comments in the default range
-
getItemsFromCommentAttachments
Returns all attachments of the abstract comment- Parameters:
abstractComment- abstract comment to get attachments from- Returns:
- all items of the comments ItemAttachment
-
isRead
Return if the comment is read by the current user or not- Returns:
- true, if comment is read, false otherwise
-
setRead
Sets the read status of the specified commentItem for the current user- Parameters:
commentItem- the commentItem (comment or reply)read- true, if commentItem should be marked as read, false otherwise
-
saveChangedComments
Saves only modified comments from comments list- Parameters:
comments- list of comments
-