de.hybris.platform.print.collaboration.services

Interface PrintCommentService

All Known Implementing Classes:

DefaultPrintCommentService

public interface PrintCommentService

Service that deals with the process of print comments. Provides methods for creating, sorting and filtering of CommentModels.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PrintCommentService.CommentType An enumeration which identifies the four different comment/job types in InDesign.

Method Summary

Modifier and Type	Method and Description
CommentModel	createComment(UserModel author, String text) This method should be used to create a CommentModel with the given UserModel and String.
void	deleteComment(CommentModel comment) This method should delete the given CommentModel.
Collection<CommentModel>	filterComments(Collection<FilterCondition> filterConditions, Collection<CommentModel> comments) This method should filter the given collection of CommentModel by the provided FilterConditions.
ReplyModel	getLastChange(CommentModel comment) This method should return the last modified ReplyModel if there are any.
List<CommentModel>	sortComments(List<SortCondition> sortConditions, List<CommentModel> comments) This method should be used for sorting the given list of CommentModels by the provided SortConditions.

Method Detail

createComment

CommentModel createComment(UserModel author,
                           String text)

This method should be used to create a CommentModel with the given UserModel and String.

Parameters:

author - the UserModel which should be set as the author of the CommentModel

text - the String which should be set for the CommentModel

Returns:

the new created CommentModel

deleteComment

void deleteComment(CommentModel comment)

This method should delete the given CommentModel. After deletion additionally the comment group should be checked for emptiness. Empty comment groups should be deleted then.

Parameters:

comment - the CommentModel which should be deleted.

filterComments

Collection<CommentModel> filterComments(Collection<FilterCondition> filterConditions,
                                        Collection<CommentModel> comments)

This method should filter the given collection of CommentModel by the provided FilterConditions.

Parameters:

filterConditions - a collection of FilterConditions which should be used for filtering the comments

comments - a collection of CommentModels including their WorkflowModel should be filtered by the given FilterConditions

Returns:

a new filtered collection of CommentModel or a empty collection if no CommentModel were given or all were filtered.

getLastChange

ReplyModel getLastChange(CommentModel comment)

This method should return the last modified ReplyModel if there are any.

Parameters:

comment - the CommentModel where the last change should be taken from

Returns:

the last created or modified ReplyModel

sortComments

List<CommentModel> sortComments(List<SortCondition> sortConditions,
                                List<CommentModel> comments)

This method should be used for sorting the given list of CommentModels by the provided SortConditions.

Parameters:

sortConditions - a list of SortConditions which should be used for sorting. Higher priorised conditions should be set first.

comments - the list of CommentModels which should be sorted with SortConditions

Returns:

a sorted CommentModels list or empty list if no CommentModels were given.