com.almworks.jira.structure.api.effect

Class EffectResponse.Error

Object

EffectResponse

EffectResponse.Error

Enclosing class:

EffectResponse

public static final class EffectResponse.Error
extends EffectResponse

Represents an error response, which means that the requested change is impossible.

See Also:

EffectResponse.error(I18nText, I18nText, List)

Nested Class Summary

Nested classes/interfaces inherited from class EffectResponse

EffectResponse.Empty, EffectResponse.Error, EffectResponse.Valid

Constructor Summary

Constructors

Constructor and Description
Error(I18nText error, I18nText description, List<ItemIdentity> affectedItems)

Method Summary

Modifier and Type	Method and Description
I18nText	getError() Describes why this effect cannot be applied, e.g.
boolean	isError() Returns whether this response is an error, which means this change cannot be applied.

Methods inherited from class EffectResponse

empty, error, getAffectedItems, getDescription, getEffect, getSuccessMessage, isEmpty, valid

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Error

public Error(@NotNull
             I18nText error,
             @NotNull
             I18nText description,
             @NotNull
             List<ItemIdentity> affectedItems)

Method Detail

getError

@NotNull
public I18nText getError()

Description copied from class: EffectResponse

Describes why this effect cannot be applied, e.g. "Issue does not exist or you have no permission to see it." Returns null for valid and empty responses.

Overrides:

getError in class EffectResponse

isError

public boolean isError()

Description copied from class: EffectResponse

Returns whether this response is an error, which means this change cannot be applied.

Overrides:

isError in class EffectResponse

See Also:

EffectResponse.getError()