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

Interface EffectRecord

@PublicApi
public interface EffectRecord

Information about a single effect applied by an effector process.

Method Summary

Modifier and Type	Method and Description
List<ItemIdentity>	getAffectedItems()
I18nText	getEffectMessage()
int	getPreviewIndex()
long	getProcessId()
long	getTimestamp()
StoredEffect	getUndoEffect()
boolean	isError()

Method Detail

getProcessId

long getProcessId()

Returns:

the ID of the process that applied the effect

getEffectMessage

@NotNull
I18nText getEffectMessage()

Returns:

the effect's success message or error message

See Also:

isError()

isError

boolean isError()

Returns:

false if the effect was successfully applied, true if there was an error

getUndoEffect

@Nullable
StoredEffect getUndoEffect()

Returns:

the description of an effect that would undo this change

getAffectedItems

@NotNull
List<ItemIdentity> getAffectedItems()

Returns:

the list of item IDs for the items changed by this effect

getTimestamp

long getTimestamp()

Returns:

the timestamp when this effect was applied

getPreviewIndex

int getPreviewIndex()

Returns:

the index of this effect in the process' preview