com.almworks.jira.structure.api.process

Interface ProcessUIController

All Known Subinterfaces:

ProcessHandle

public interface ProcessUIController

ProcessUIController allows configure UI for the process status page.

If you know processId, you can access its UI controller using ProcessHandleManager.getUIController(Long) method.

Method Summary

Modifier and Type	Method and Description
void	setParameters(ProcessDisplayParameters parameters)
void	setProgress(I18nText activity, Integer percentComplete) Updates process progress information

Method Detail

setParameters

void setParameters(@Nullable
                   ProcessDisplayParameters parameters)

setProgress

void setProgress(@Nullable
                 I18nText activity,
                 @Nullable
                 Integer percentComplete)

Updates process progress information

Parameters:

activity - Current activity description, null to keep activity unchanged

percentComplete - Completion percentage, 0 to 100, or -1 for unknown/indeterminate, or null too keep percentage unchanged

Throws:

IllegalArgumentException - if percentComplete is less than -1 or greater than 100