de.hybris.platform.print.collaboration.services

Interface PrintJobService

All Known Implementing Classes:

DefaultPrintJobService

public interface PrintJobService

A service handling job related actions, like assigning or creating jobs, fetch the current actions or fetching a job's history.

Method Summary

Modifier and Type	Method and Description
void	assignJob(WorkflowModel workflow, PrincipalModel principal) This method should be used to handle the assignment of the given UserModel to the given WorkflowModel.
WorkflowModel	createJob(AbstractCommentModel workflowJob, ItemModel attachment, PrincipalModel assignee) This method should be used to create a WorkflowModel for the given CommentModel.
PrincipalModel	getAssignee(UserModel user) This method should find a PrincipalModel for the given UserModel which has all access rights to edit/create CommentModels and change the states within a WorkflowModel.
List<WorkflowActionModel>	getCurrentActions(WorkflowModel workflow) This method should be used to get the current active WorkflowActionModels of the given WorkflowModel.
List<PrintJobHistoryEntryDTO>	getJobHistory(WorkflowModel workflow) This method should be used to get a list of PrintJobHistoryEntryDTO from the WorkflowModel sorted by creation time.
boolean	isStatusChangeAllowed(UserModel currentUser, WorkflowModel workflow) This method checks if a user is actually allowed to make a status change on the given workflow.

Method Detail

assignJob

void assignJob(WorkflowModel workflow,
               PrincipalModel principal)

This method should be used to handle the assignment of the given UserModel to the given WorkflowModel.

Parameters:

workflow - the WorkflowModel which will be given the UserModel as assignee

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

createJob

WorkflowModel createJob(AbstractCommentModel workflowJob,
                        ItemModel attachment,
                        PrincipalModel assignee)

This method should be used to create a WorkflowModel for the given CommentModel.

Parameters:

workflowJob - the CommentModel for which the WorkflowModel should be created.

attachment - the item which should be set to the WorkflowModel

assignee - the UserModel or UserGroupModel which should be set as the assignee of the WorkflowModel

Returns:

the new created WorkflowModel

getAssignee

PrincipalModel getAssignee(UserModel user)

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

Parameters:

user - the UserModel where the PrincipalModels should be taken

Returns:

a valid PrincipalModel which may be the UserModel itself or one of its groups

getCurrentActions

List<WorkflowActionModel> getCurrentActions(WorkflowModel workflow)

This method should be used to get the current active WorkflowActionModels of the given WorkflowModel.

Parameters:

workflow - the WorkflowModel where the current WorkflowActionModel should be found

Returns:

the current WorkflowActionModels of the given WorkflowModel or empty List.

getJobHistory

List<PrintJobHistoryEntryDTO> getJobHistory(WorkflowModel workflow)

This method should be used to get a list of PrintJobHistoryEntryDTO from the WorkflowModel sorted by creation time.

Parameters:

workflow - WorkflowModel where the PrintJobHistoryEntryDTO should be taken.

Returns:

a PrintJobHistoryEntryDTOs list sorted by creation time.

isStatusChangeAllowed

boolean isStatusChangeAllowed(UserModel currentUser,
                              WorkflowModel workflow)

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

Parameters:

currentUser - The user that will be checked permission on

workflow - The affected workflow

Returns:

True if the user is allowed to, false otherwise