com.almworks.jira.structure.api.effector.process

Interface EffectorProcess

@PublicApi
public interface EffectorProcess

Represents an Effector preview, effect application, or undo background process started by a user.

Please note that an instance of this class is just a snapshot of the state of the process at the time when the instance itself was created. For those attributes that are supposed to change over time, like status, calling the corresponding method on the same instance will not return up-to-date values, you must obtain a new EffectorProcess instance instead.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EffectorProcess.Status Represents the status of an effector process.

Method Summary

Modifier and Type	Method and Description
EffectorPreview	getEffectorPreview() Generated effects for preview, not yet applied.
Long	getFinishTime()
long	getId()
long	getProcessHandleId() Returns the ID of this process' ProcessHandle.
Long	getRevertedProcessId()
Long	getStartTime()
EffectorProcess.Status	getStatus()
String	getUserKey()
boolean	isAcknowledged()

Method Detail

getId

long getId()

Returns:

process ID

getProcessHandleId

long getProcessHandleId()

Returns the ID of this process' ProcessHandle. The process handle can be used to check the progress of the process.

Returns:

process handle ID

See Also:

ProcessHandleManager.getInfo(Long)

getEffectorPreview

@Nullable
EffectorPreview getEffectorPreview()

Generated effects for preview, not yet applied. Non-empty if getStatus() is one of CALCULATED, QUEUED, or IN_PROGRESS.

getStatus

@NotNull
EffectorProcess.Status getStatus()

Returns:

the status of the process

getUserKey

@NotNull
String getUserKey()

Returns:

the userkey of the process owner

getStartTime

@Nullable
Long getStartTime()

Returns:

the timestamp when the process started doing actual work, i.e. transitioned to the CALCULATING or IN_PROGRESS status

getFinishTime

@Nullable
Long getFinishTime()

Returns:

the timestamp when the process finished calculating the preview or applying effects.

getRevertedProcessId

@Nullable
Long getRevertedProcessId()

Returns:

the ID of an earlier effector process whose effects are being reverted by this process, if applicable

isAcknowledged

boolean isAcknowledged()

Returns:

the "acknowledged" flag for this process

See Also:

EffectorProcessManager.acknowledgeFinished(long)