Package com.almworks.jira.structure.api.effect

Class EffectResponse.Valid

Object

EffectResponse

Valid

Enclosing class:

EffectResponse

public static final class EffectResponse.Valid
extends EffectResponse

Represents a valid response, which means that the requested change is both needed and possible.

See Also:

• EffectResponse.valid(Effect, I18nText, I18nText, List)

Nested Class Summary

Nested classes/interfaces inherited from class EffectResponse

EffectResponse.Empty, EffectResponse.Error, EffectResponse.Valid

Method Summary

Modifier and Type	Method	Description
Effect	getEffect()	Returns the actual effect, or null if error or empty.
I18nText	getSuccessMessage()	Returns a human-readable description of the change, as if it already happened, e.g.

Methods inherited from class EffectResponse

empty, error, getAffectedItems, getDescription, getError, isEmpty, isError, valid

Methods inherited from class Object

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

Method Details

getEffect

@NotNull
public Effect getEffect()

Description copied from class: EffectResponse

Returns the actual effect, or null if error or empty.

Overrides:

getEffect in class EffectResponse

getSuccessMessage

@NotNull
public I18nText getSuccessMessage()

Description copied from class: EffectResponse

Returns a human-readable description of the change, as if it already happened, e.g. "Assigned FOO-123 to John Doe."

This description is null for error and empty responses.

Overrides:

getSuccessMessage in class EffectResponse