Package com.almworks.jira.structure.api.process

Interface ProcessInfo

All Known Subinterfaces:

ProcessHandle

public interface ProcessInfo

ProcessInfo allows communication between process owner and process itself.

If you know processId, you can access its state using ProcessHandleManager.getInfo(Long) method.

Method Summary

Modifier and Type	Method	Description
void	cancel()	Ask the process to stop.
I18nText	getActivity()
ProcessDisplayParameters	getParameters()
int	getPercentComplete()
ProcessStatus	getStatus()
boolean	isVisibleTo(ApplicationUser user)

Method Details

getStatus

@Nullable
ProcessStatus getStatus()

Returns:

Actual status of the process. Null if there is no such process

getParameters

@Nullable
ProcessDisplayParameters getParameters()

Returns:

Process display parameters (process name, buttons). Null if there is no such process

isVisibleTo

boolean isVisibleTo(@Nullable
 ApplicationUser user)

Parameters:

user - User key

Returns:

true if state is visible for the user. false if there is no such process

getActivity

@Nullable
I18nText getActivity()

Returns:

A short description of the current activity. Null if there is no such process.

getPercentComplete

int getPercentComplete()

Returns:

Process completion percentage, 0 to 100. -1 if progress is unknown/indeterminate or there is no such process

cancel

void cancel()

Ask the process to stop. It's up to the process to decide what to do about this request. No effect if there is no such process.