de.hybris.platform.print.collaboration.facades.impl

Class DefaultPrintCollaborationFacade

java.lang.Object

de.hybris.platform.print.collaboration.facades.impl.DefaultPrintCollaborationFacade

All Implemented Interfaces:

PrintCollaborationFacade

public class DefaultPrintCollaborationFacade
extends Object
implements PrintCollaborationFacade

Constructor Summary

Constructors

Constructor and Description
DefaultPrintCollaborationFacade()

Method Summary

Modifier and Type	Method and Description
void	assignJob(AbstractCommentModel comment, PrincipalModel principal) This method should assign the WorkflowModel of the given job to the given UserModel or UserGroupModel.
CommentModel	createComment(PageModel page, UserModel author, String text) This method should create a CommentModel for the given PageModel, UserModel and text.
void	createJob(AbstractCommentModel commentToSave, ItemModel attachment, PrincipalModel assignee) This method should create a WorkflowModel, it should attach it to the given CommentModel and assign it to the given UserModel or UserGroupModel.
void	createReply(AbstractCommentModel abstractComment, UserModel author, String text, WorkflowDecisionModel selectedDecision) Creates a reply for the selected decision and the given comment or reply.
void	deleteComment(CommentModel comment) This method should delete the given CommentModel.
Collection<CommentModel>	filterAndSortComments(Collection<FilterCondition> filterConditions, List<SortCondition> sortConditions, Collection<CommentModel> comments) This method should filter the given collection of CommentModels by the given FilterConditions and sorts it by the given SortConditions afterwards.
PrincipalModel	getAssignee(UserModel principal) This method should find a PrincipalModel (e.g.
WorkflowActionModel	getCurrentAction(AbstractCommentModel comment) This method should find the current status of the given AbstractCommentModel.
List<PrintJobHistoryEntryDTO>	getJobHistory(AbstractCommentModel commentItemModel) This method should find PrintJobHistoryEntryDTOs for the WorkflowModel of the given job .
ItemModel	getLastChange(CommentModel comment) This method returns either a ReplyModel or a WorkflowActionModel depending on which has been last modified or created.
boolean	isDeleteAllowed(AbstractCommentModel comment) This method verifies if a AbstractCommentModel may be removed.
boolean	isJob(AbstractCommentModel comment) This method checks if the given comment is a job.
boolean	isStatusChangeAllowed(UserModel currentUser, AbstractCommentModel comment) This method checks if a user is actually allowed to make a status change on the given comment.
void	setCommentGroupService(CommentGroupService commentGroupService)
void	setCommentService(CommentService commentService)
void	setModelService(ModelService modelService)
void	setPrintCommentService(PrintCommentService printCommentService)
void	setPrintJobService(PrintJobService printJobService)
void	setWorkflowProcessingService(WorkflowProcessingService workflowProcessingService)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPrintCollaborationFacade

public DefaultPrintCollaborationFacade()

Method Detail

assignJob

public void assignJob(AbstractCommentModel comment,
                      PrincipalModel principal)

Description copied from interface: PrintCollaborationFacade

This method should assign the WorkflowModel of the given job to the given UserModel or UserGroupModel. This method should delegate to PrintJobService.assignJob for the actual assignment.

Specified by:

assignJob in interface PrintCollaborationFacade

Parameters:

comment - CommentModel where the WorkflowModel should be taken

principal - the UserModel or UserGroupModel which should be assigned to the WorkflowModel

createComment

public CommentModel createComment(PageModel page,
                                  UserModel author,
                                  String text)

Description copied from interface: PrintCollaborationFacade

This method should create a CommentModel for the given PageModel, UserModel and text. Should return the CommentModel without persisting it using the ModelService. The caller of this method needs to take care about saving the CommentModel. This method should delegate PrintCommentService.createComment for the actual assignment.

Specified by:

createComment in interface PrintCollaborationFacade

Parameters:

page - the PageModel the CommentModel should be attached to

author - the UserModel should be set as assignee for the created CommentModel

text - the String which should be set for the CommentModel

Returns:

the created CommentModel which is not persisted.

createJob

public void createJob(AbstractCommentModel commentToSave,
                      ItemModel attachment,
                      PrincipalModel assignee)

Description copied from interface: PrintCollaborationFacade

This method should create a WorkflowModel, it should attach it to the given CommentModel and assign it to the given UserModel or UserGroupModel. The caller of this method needs to take care about saving all created models by calling modelService.saveAll(). This method should delegate to PrintJobService.createJob for the actual assignment.

Specified by:

createJob in interface PrintCollaborationFacade

Parameters:

commentToSave - the CommentModel to which the WorkflowModel should be created for

attachment - the ItemModel which should be attached to the WorkflowModel

assignee - the UserModel or UserGroupModel which should be set as the assigned principle of the created WorkflowModel.

createReply

public void createReply(AbstractCommentModel abstractComment,
                        UserModel author,
                        String text,
                        WorkflowDecisionModel selectedDecision)

Description copied from interface: PrintCollaborationFacade

Creates a reply for the selected decision and the given comment or reply. This ensures that a reply is connected to a state change in the print workflow process and will then no longer be deletable if the selected decision is not null.

Specified by:

createReply in interface PrintCollaborationFacade

Parameters:

abstractComment - comment to reply to

author - the UserModel, who created the reply

text - reply content

selectedDecision - selected decision within the workflow

isDeleteAllowed

public boolean isDeleteAllowed(AbstractCommentModel comment)

Description copied from interface: PrintCollaborationFacade

This method verifies if a AbstractCommentModel may be removed. By default a comment may not be deleted if it is already synchronized to InDesign once and a reply may not be deleted if it belongs to a state change.

Specified by:

isDeleteAllowed in interface PrintCollaborationFacade

Parameters:

comment - the AbstractCommentModel which is used for the verification.

isJob

public boolean isJob(AbstractCommentModel comment)

Description copied from interface: PrintCollaborationFacade

This method checks if the given comment is a job.

Specified by:

isJob in interface PrintCollaborationFacade

Parameters:

comment - The affected comment

Returns:

True if the comment is a job, false otherwise

isStatusChangeAllowed

public boolean isStatusChangeAllowed(UserModel currentUser,
                                     AbstractCommentModel comment)

Description copied from interface: PrintCollaborationFacade

This method checks if a user is actually allowed to make a status change on the given comment. This method checks if the given comment is a job.

Specified by:

isStatusChangeAllowed in interface PrintCollaborationFacade

Parameters:

currentUser - The user that will be checked permission on

comment - The affected comment

Returns:

True if the user is allowed to, false otherwise

deleteComment

public void deleteComment(CommentModel comment)
                   throws BusinessException

Description copied from interface: PrintCollaborationFacade

This method should delete the given CommentModel. In case deletion is restricted a BusinessException is thrown.

Specified by:

deleteComment in interface PrintCollaborationFacade

Parameters:

comment - the CommentModel which should be deleted.

Throws:

BusinessException

filterAndSortComments

public Collection<CommentModel> filterAndSortComments(Collection<FilterCondition> filterConditions,
                                                      List<SortCondition> sortConditions,
                                                      Collection<CommentModel> comments)

Description copied from interface: PrintCollaborationFacade

This method should filter the given collection of CommentModels by the given FilterConditions and sorts it by the given SortConditions afterwards. This method should delegate PrintCommentService.filterComments and PrintCommentService.sortComments for the actual assignment.

Specified by:

filterAndSortComments in interface PrintCollaborationFacade

Parameters:

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

sortConditions - a list of SortConditions which should be used for sorting the comments

comments - a collection of CommentModel which should be filtered by the given FilterCondition and SortConditions

Returns:

a filtered and sorted collection of CommentModels or empty collection if the list is empty after filtering.

getAssignee

public PrincipalModel getAssignee(UserModel principal)

Description copied from interface: PrintCollaborationFacade

This method should find a PrincipalModel (e.g. UserGroupModel) for the given UserModel which has all access rights to edit/create CommentModels and change the states within a WorkflowModel.

Specified by:

getAssignee in interface PrintCollaborationFacade

Parameters:

principal - the UserModel where the PrincipalModels should be taken

Returns:

a valid PrincipalModel

getCurrentAction

public WorkflowActionModel getCurrentAction(AbstractCommentModel comment)

Description copied from interface: PrintCollaborationFacade

This method should find the current status of the given AbstractCommentModel. It should delegate to PrintJobService.getCurrentActionsfor the actual assignment.

Specified by:

getCurrentAction in interface PrintCollaborationFacade

Parameters:

comment - the AbstractCommentModel where the current WorkflowActionModel should be taken from

Returns:

the current WorkflowActionModel of the given AbstractCommentModel if it is a job, null otherwise

getJobHistory

public List<PrintJobHistoryEntryDTO> getJobHistory(AbstractCommentModel commentItemModel)

Description copied from interface: PrintCollaborationFacade

This method should find PrintJobHistoryEntryDTOs for the WorkflowModel of the given job . It also should delegate PrintJobService.getJobHistory for the actual assignment.

Specified by:

getJobHistory in interface PrintCollaborationFacade

Parameters:

commentItemModel - the CommentModel where the PrintJobHistoryEntryDTOs should be taken from

Returns:

a list of PrintJobHistoryEntryDTOs which were found for the given CommentModel

getLastChange

public ItemModel getLastChange(CommentModel comment)

Description copied from interface: PrintCollaborationFacade

This method returns either a ReplyModel or a WorkflowActionModel depending on which has been last modified or created. This method delegates to PrintCommentService.getLastChange for fetching the latest ReplyModel and PrintJobService.getCurrentActions(de.hybris.platform.workflow.model.WorkflowModel) getLastChange(de.hybris.platform.workflow.model.WorkflowModel) PrintJobService.getLastChange} for fetching the latest WorkflowActionModel.

Specified by:

getLastChange in interface PrintCollaborationFacade

Parameters:

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

Returns:

the last created or modified ItemModel

setCommentService

public void setCommentService(CommentService commentService)

setCommentGroupService

public void setCommentGroupService(CommentGroupService commentGroupService)

setModelService

public void setModelService(ModelService modelService)

setPrintCommentService

public void setPrintCommentService(PrintCommentService printCommentService)

setPrintJobService

public void setPrintJobService(PrintJobService printJobService)

setWorkflowProcessingService

public void setWorkflowProcessingService(WorkflowProcessingService workflowProcessingService)