com.almworks.jira.structure.api.process

Interface ProcessHandleManager

public interface ProcessHandleManager

ProcessHandleManager allows to create new processes and access existing ones

Method Summary

Modifier and Type	Method and Description
ProcessHandle	createNew(ApplicationUser managingUser, ProcessDisplayParameters displayParameters) Creates new process
void	delete(long id) Deletes the process with the given id
ProcessFeedback	getFeedback(Long id)
ProcessInfo	getInfo(Long id)
ProcessUIController	getUIController(Long id)

Method Detail

createNew

@NotNull
ProcessHandle createNew(@Nullable
                                 ApplicationUser managingUser,
                                 @Nullable
                                 ProcessDisplayParameters displayParameters)

Creates new process

Parameters:

managingUser - User that will be allowed to manage the process

displayParameters - Display parameters of the process

Returns:

ProcessHandle object to read and update process state

getInfo

@Nullable
ProcessInfo getInfo(@NotNull
                              Long id)

Parameters:

id - ID of the process

Returns:

ProcessInfo object to read process state. Null if there is no such process

getFeedback

@Nullable
ProcessFeedback getFeedback(@NotNull
                                      Long id)

Parameters:

id - ID of the process

Returns:

ProcessFeedback object to update process state. Null if there is no such process

getUIController

@Nullable
ProcessUIController getUIController(@NotNull
                                              Long id)

Parameters:

id - ID of the process

Returns:

ProcessUIController object to update UI. Null if there is no such process

delete

void delete(long id)

Deletes the process with the given id

Parameters:

id - ID of the process