Package de.hybris.platform.cockpit.services.impl

Class DefaultCockpitCommentService

java.lang.Object

de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

de.hybris.platform.cockpit.services.impl.DefaultCockpitCommentService

All Implemented Interfaces:

CockpitCommentService

public class DefaultCockpitCommentService
extends AbstractServiceImpl
implements CockpitCommentService

Field Summary

Fields inherited from class de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

modelService, typeService

Constructor Summary

Constructors

Constructor	Description
DefaultCockpitCommentService()

Method Summary

Modifier and Type	Method	Description
CommentModel	createItemComment(UserModel author, ComponentModel component, CommentTypeModel type, Collection<ItemModel> items, String subject, String text)	Creates and returns a new item comment.
ReplyModel	createReply(UserModel author, AbstractCommentModel comment, String text)	Creates and returns a new comment reply.
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 where user is a participant.
CommentService	getCommentService()	Deprecated. since 6.3
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.
List<CommentModel>	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.
Query	getCurrentUserCommentsQuery()	Get current user comments query.
List<ReplyModel>	getDirectReplies(CommentModel comment, int offset, int count)	Returns all direct comment replies for the specified comment.
List<CommentModel>	getItemComments(ItemModel item, UserModel user, Collection<ComponentModel> components, Collection<CommentTypeModel> types, int offset, int count)	Gets comments.
Query	getItemCommentsQuery(ItemModel item, UserModel user, Collection<ComponentModel> components, Collection<CommentTypeModel> types)	Get item comments query.
List<ItemModel>	getItemsFromCommentAttachments(AbstractCommentModel abstractComment)	Returns all attachments of the abstract comment
UserService	getUserService()	Deprecated. since 6.3
boolean	isRead(TypedObject commentItem)	Return if the comment is read by the current user or not
void	saveChangedComments(List<CommentModel> comments)	Saves only modified comments from comments list
void	setCommentService(CommentService commentService)
void	setRead(TypedObject commentItem, boolean read)	Sets the read status of the specified commentItem for the current user
protected void	setRead(UserModel user, AbstractCommentModel commentItemModel, boolean read)
void	setUserService(UserService userService)

Methods inherited from class de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

getEnum, getEnums, getLocalizedLabel, getLocalizedLabel, getModelService, getTypeService, setCockpitTypeService, setLabelResolver, setModelService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultCockpitCommentService

public DefaultCockpitCommentService()

Method Details

getItemComments

public List<CommentModel> getItemComments(ItemModel item,
 UserModel user,
 Collection<ComponentModel> components,
 Collection<CommentTypeModel> types,
 int offset,
 int count)

Description copied from interface: CockpitCommentService

Gets comments.

Specified by:

getItemComments in interface CockpitCommentService

Parameters:

item - the item that has been commented on

user - the author

components - the related comment components

types - the comment type

offset - the search offset

count - the maximum number of comments to return

Returns:

list of all the comments matching the specified criteria

getItemCommentsQuery

public Query getItemCommentsQuery(ItemModel item,
 UserModel user,
 Collection<ComponentModel> components,
 Collection<CommentTypeModel> types)

Description copied from interface: CockpitCommentService

Get item comments query.

Specified by:

getItemCommentsQuery in interface CockpitCommentService

Parameters:

item - the item that has been commented on

user - the author or the watcher or the user assigned to the comment

components - the related comment components

types - the comment type

Returns:

query for getting all comments matching the specified criteria

getCurrentUserCommentsQuery

public Query getCurrentUserCommentsQuery()

Description copied from interface: CockpitCommentService

Get current user comments query.

Specified by:

getCurrentUserCommentsQuery in interface CockpitCommentService

Returns:

query for getting all current user comments

createReply

public ReplyModel createReply(UserModel author,
 AbstractCommentModel comment,
 String text)

Description copied from interface: CockpitCommentService

Creates and returns a new comment reply.

Specified by:

createReply in interface CockpitCommentService

Parameters:

author - reply author

comment - comment to reply to

text - reply content

Returns:

created reply

createItemComment

public CommentModel createItemComment(UserModel author,
 ComponentModel component,
 CommentTypeModel type,
 Collection<ItemModel> items,
 String subject,
 String text)

Description copied from interface: CockpitCommentService

Creates and returns a new item comment.

Specified by:

createItemComment in interface CockpitCommentService

Parameters:

author - comment author

component - comment domain component

type - comment type

items - related items

subject - comment subject

text - comment content

Returns:

created comment

getDirectReplies

public List<ReplyModel> getDirectReplies(CommentModel comment,
 int offset,
 int count)

Description copied from interface: CockpitCommentService

Returns all direct comment replies for the specified comment.

Specified by:

getDirectReplies in interface CockpitCommentService

Parameters:

comment - the comment

offset - search offset

count - max hit count

Returns:

all found comments in the specified range

getComments

public List<CommentModel> getComments(UserModel user,
 Collection<ComponentModel> components,
 Collection<CommentTypeModel> types,
 int offset,
 int count)

Description copied from interface: CockpitCommentService

Returns all comments in the specified domain components which are of the specified types and where user is a participant.

Specified by:

getComments in interface CockpitCommentService

Parameters:

user - comment participant

components - domain components

types - comment types

offset - search offset

count - max hit count

Returns:

all found comments in the specified range

getCurrentUserComments

public List<CommentModel> getCurrentUserComments()

Description copied from interface: CockpitCommentService

Returns all comments in the default domain components which are of the default types and where the current user is a participant.

Specified by:

getCurrentUserComments in interface CockpitCommentService

Returns:

all found comments in the default range

getCurrentUserComments

public List<CommentModel> getCurrentUserComments(org.zkoss.zk.ui.Desktop desktop)

Description copied from interface: CockpitCommentService

Returns all comments in the default domain components which are of the default types and where the current user is a participant.

Specified by:

getCurrentUserComments in interface CockpitCommentService

Returns:

all found comments in the default range

isRead

public boolean isRead(TypedObject commentItem)

Description copied from interface: CockpitCommentService

Return if the comment is read by the current user or not

Specified by:

isRead in interface CockpitCommentService

Returns:

true, if comment is read, false otherwise

setRead

public void setRead(TypedObject commentItem,
 boolean read)

Description copied from interface: CockpitCommentService

Sets the read status of the specified commentItem for the current user

Specified by:

setRead in interface CockpitCommentService

Parameters:

commentItem - the commentItem (comment or reply)

read - true, if commentItem should be marked as read, false otherwise

setRead

protected void setRead(UserModel user,
 AbstractCommentModel commentItemModel,
 boolean read)

getCommentService

@Deprecated
public CommentService getCommentService()

Deprecated.

since 6.3

setCommentService

public void setCommentService(CommentService commentService)

getUserService

@Deprecated
public UserService getUserService()

Deprecated.

since 6.3

setUserService

public void setUserService(UserService userService)

getItemsFromCommentAttachments

public List<ItemModel> getItemsFromCommentAttachments(AbstractCommentModel abstractComment)

Description copied from interface: CockpitCommentService

Returns all attachments of the abstract comment

Specified by:

getItemsFromCommentAttachments in interface CockpitCommentService

Parameters:

abstractComment - abstract comment to get attachments from

Returns:

all items of the comments ItemAttachment

saveChangedComments

public void saveChangedComments(List<CommentModel> comments)

Description copied from interface: CockpitCommentService

Saves only modified comments from comments list

Specified by:

saveChangedComments in interface CockpitCommentService

Parameters:

comments - list of comments