com.almworks.jira.structure.api.effect

Class CoreEffects

Object

CoreEffects

@PublicApi
public final class CoreEffects
extends Object

Produces effect descriptions for common effects provided by Structure.

Method Summary

Modifier and Type	Method and Description
static StoredEffect	assignIssue(Issue issue, ApplicationUser assignee) Returns a description of an effect that would assign an issue to the given user.
static StoredEffect	emitWarning(I18nText i18nText, List<ItemIdentity> itemIdentities) Returns a description of an effect that can't be deserialized successfully but used to describe a specific problem.
static StoredEffect	setCascadeCustomField(Issue issue, CustomField customField, Option value) Returns a description of an effect that would set a cascading select custom field to the given option.
static StoredEffect	setDateCustomField(Issue issue, CustomField customField, Date value) Returns a description of an effect that would set a date custom field to the given value.
static StoredEffect	setDateTimeCustomField(Issue issue, CustomField customField, Date value) Returns a description of an effect that would set a date time custom field to the given value.
static StoredEffect	setIssueDescription(Issue issue, String description) Returns a description of an effect that would change an issue Description field to the given value.
static StoredEffect	setIssueDueDate(Issue issue, Date date) Returns a description of an effect that would change an issue due date to the given value.
static StoredEffect	setIssueEnvironment(Issue issue, String environment) Returns a description of an effect that would change an issue Environment field to the given value.
static StoredEffect	setIssuePriority(Issue issue, Priority priority) Returns a description of an effect that would change an issue priority to the given value.
static StoredEffect	setIssueReporter(Issue issue, ApplicationUser reporter) Returns a description of an effect that would set an issue reporter to the given user.
static StoredEffect	setIssueResolution(Issue issue, Resolution resolution) Returns a description of an effect that would change an issue Resolution field to the given value.
static StoredEffect	setIssueResolutionDate(Issue issue, Date date) Deprecated. The "Resolved" field in Jira is not editable, and this method should not be used. There is no corresponding effect provider in Structure.
static StoredEffect	setIssueStatus(Issue issue, Status status) Returns a description of an effect that would transition an issue to the given status.
static StoredEffect	setIssueSummary(Issue issue, String summary) Returns a description of an effect that would change an issue summary to the given value.
static StoredEffect	setNumberCustomField(Issue issue, CustomField customField, Number value) Returns a description of an effect that would set a number custom field to the given value.
static StoredEffect	setProjectPickerCustomField(Issue issue, CustomField customField, Project value) Returns a description of an effect that would set a project picker custom field to the given value.
static StoredEffect	setSingleSelectCustomField(Issue issue, CustomField customField, Option value) Returns a description of an effect that would set a single select custom field to the given option.
static StoredEffect	setSingleUserCustomField(Issue issue, CustomField customField, ApplicationUser value) Returns a description of an effect that would set a single user custom field to the given value.
static StoredEffect	setSingleVersionCustomField(Issue issue, CustomField customField, Version value) Returns a description of an effect that would set a single version custom field to the given value.
static StoredEffect	setTextCustomField(Issue issue, CustomField customField, String value) Returns a description of an effect that would set a text custom field to the given value.

Methods inherited from class Object

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

Method Detail

emitWarning

@NotNull
public static StoredEffect emitWarning(@NotNull
                                                I18nText i18nText,
                                                @NotNull
                                                List<ItemIdentity> itemIdentities)

Returns a description of an effect that can't be deserialized successfully but used to describe a specific problem.

Parameters:

i18nText - The warning message.

itemIdentities - An ID list of items to which the warning message is related.

Returns:

The effect description.

assignIssue

@NotNull
public static StoredEffect assignIssue(@NotNull
                                                Issue issue,
                                                @Nullable
                                                ApplicationUser assignee)

Returns a description of an effect that would assign an issue to the given user. The reverse effect would restore the assignee value that the issue had when the effect was applied. The returned effect would deserialize successfully only if the given user has the permission to the given issue, and the assignee is assignable.

Parameters:

issue - The issue.

assignee - The user to set. Passing null will make the issue unassigned.

Returns:

The effect description.

setIssueReporter

@NotNull
public static StoredEffect setIssueReporter(@NotNull
                                                     Issue issue,
                                                     @Nullable
                                                     ApplicationUser reporter)

Returns a description of an effect that would set an issue reporter to the given user. The reverse effect would restore the reporter that the issue had when the effect was applied.

Parameters:

issue - The issue.

reporter - The user to set. Passing null will clear the reporter value.

Returns:

The effect description.

setIssuePriority

@NotNull
public static StoredEffect setIssuePriority(@NotNull
                                                     Issue issue,
                                                     @Nullable
                                                     Priority priority)

Returns a description of an effect that would change an issue priority to the given value. The reverse effect would restore the priority that the issue had when the effect was applied.

Parameters:

issue - The issue.

priority - The priority to set. Passing null will clear the priority value.

Returns:

the effect description.

setIssueDescription

@NotNull
public static StoredEffect setIssueDescription(@NotNull
                                                        Issue issue,
                                                        @Nullable
                                                        String description)

Returns a description of an effect that would change an issue Description field to the given value. The reverse effect would restore the Description field value that the issue had when the effect was applied.

Parameters:

issue - The issue.

description - The description value to set. Passing null will clear an issue description.

Returns:

the effect description.

setIssueEnvironment

@NotNull
public static StoredEffect setIssueEnvironment(@NotNull
                                                        Issue issue,
                                                        @Nullable
                                                        String environment)

Returns a description of an effect that would change an issue Environment field to the given value. The reverse effect would restore the environment that the issue had when the effect was applied.

Parameters:

issue - The issue.

environment - The environment value to set. Passing null will clear the Environment field value.

Returns:

the effect description.

setIssueResolution

@NotNull
public static StoredEffect setIssueResolution(@NotNull
                                                       Issue issue,
                                                       @Nullable
                                                       Resolution resolution)

Returns a description of an effect that would change an issue Resolution field to the given value. The reverse effect would restore the resolution that the issue had when the effect was applied.

Parameters:

issue - The issue.

resolution - The resolution to set. Passing null will clear the Resolution field value.

Returns:

the effect description.

setIssueSummary

@NotNull
public static StoredEffect setIssueSummary(@NotNull
                                                    Issue issue,
                                                    @Nullable
                                                    String summary)

Returns a description of an effect that would change an issue summary to the given value. The reverse effect would restore the summary that the issue had when the effect was applied.

Parameters:

issue - The issue.

summary - The summary value to set. Passing null will clear the issue summary.

Returns:

the effect description.

setIssueDueDate

@NotNull
public static StoredEffect setIssueDueDate(@NotNull
                                                    Issue issue,
                                                    @Nullable
                                                    Date date)

Returns a description of an effect that would change an issue due date to the given value. The reverse effect would restore the due date value that the issue had when the effect was applied.

Parameters:

issue - The issue.

date - The due date to set. Passing null will clear the issue due date.

Returns:

the effect description.

setIssueResolutionDate

@NotNull
 @Deprecated
public static StoredEffect setIssueResolutionDate(@NotNull
                                                                        Issue issue,
                                                                        @Nullable
                                                                        Date date)

Deprecated. The "Resolved" field in Jira is not editable, and this method should not be used. There is no corresponding effect provider in Structure.

Returns a description of an effect that would change an issue resolution date to the given value.

Parameters:

issue - The issue.

date - The resolution date to set. Passing null will clear the issue resolution date.

Returns:

the effect description.

setIssueStatus

@NotNull
public static StoredEffect setIssueStatus(@NotNull
                                                   Issue issue,
                                                   @Nullable
                                                   Status status)

Returns a description of an effect that would transition an issue to the given status. The reverse effect would transition the issue to the status it had when the effect was applied. The returned effect would deserialize successfully only if there's exactly one direct transition from the issue's current status to the given status, and that transition has no associated screen.

Parameters:

issue - The issue.

status - The status. Passing null is allowed, but would produce an effect that would always deserialize with an error.

Returns:

The effect description.

setSingleSelectCustomField

@NotNull
public static StoredEffect setSingleSelectCustomField(@NotNull
                                                               Issue issue,
                                                               @NotNull
                                                               CustomField customField,
                                                               @Nullable
                                                               Option value)

Returns a description of an effect that would set a single select custom field to the given option. The inverse effect would restore the value that the given issue had when the effect was applied.

Parameters:

issue - The issue.

customField - The custom field, must be a single select custom field.

value - The option to set. Passing null will clear the field value.

Returns:

The effect description.

Throws:

IllegalArgumentException - if the given custom field is not a single select field.

setProjectPickerCustomField

@NotNull
public static StoredEffect setProjectPickerCustomField(@NotNull
                                                                Issue issue,
                                                                @NotNull
                                                                CustomField customField,
                                                                @Nullable
                                                                Project value)

Returns a description of an effect that would set a project picker custom field to the given value. The inverse effect would restore the value that the given issue had when the effect was applied.

Parameters:

issue - The issue.

customField - The custom field, must be a project picker custom field.

value - The project value to set. Passing null will clear the field value.

Returns:

The effect description.

Throws:

IllegalArgumentException - if the given custom field is not a project picker field.

setSingleUserCustomField

@NotNull
public static StoredEffect setSingleUserCustomField(@NotNull
                                                             Issue issue,
                                                             @NotNull
                                                             CustomField customField,
                                                             @Nullable
                                                             ApplicationUser value)

Returns a description of an effect that would set a single user custom field to the given value. The inverse effect would restore the value that the given issue had when the effect was applied.

Parameters:

issue - The issue.

customField - The custom field, must be a single user custom field.

value - The user to set. Passing null will clear the field value.

Returns:

The effect description.

Throws:

IllegalArgumentException - if the given custom field is not a single user field.

setSingleVersionCustomField

@NotNull
public static StoredEffect setSingleVersionCustomField(@NotNull
                                                                Issue issue,
                                                                @NotNull
                                                                CustomField customField,
                                                                @Nullable
                                                                Version value)

Returns a description of an effect that would set a single version custom field to the given value. The inverse effect would restore the value that the given issue had when the effect was applied. The returned effect would deserialize successfully only if the given version is not archived and belongs to the same project as the given issue.

Parameters:

issue - The issue.

customField - The custom field, must be a single version custom field.

value - The version to set. Passing null will clear the field value.

Returns:

The effect description.

Throws:

IllegalArgumentException - if the given custom field is not a single version field.

setTextCustomField

@NotNull
public static StoredEffect setTextCustomField(@NotNull
                                                       Issue issue,
                                                       @NotNull
                                                       CustomField customField,
                                                       @Nullable
                                                       String value)

Returns a description of an effect that would set a text custom field to the given value. The inverse effect would restore the value that the given issue had when the effect was applied.

Parameters:

issue - The issue.

customField - The custom field, must be a text custom field.

value - The text value to set. Passing null will clear the field value.

Returns:

The effect description.

Throws:

IllegalArgumentException - if the given custom field is not a text field.

setNumberCustomField

@NotNull
public static StoredEffect setNumberCustomField(@NotNull
                                                         Issue issue,
                                                         @NotNull
                                                         CustomField customField,
                                                         @Nullable
                                                         Number value)

Returns a description of an effect that would set a number custom field to the given value. The inverse effect would restore the value that the given issue had when the effect was applied.

Parameters:

issue - The issue.

customField - The custom field, must be a number custom field.

value - The number value to set. Passing null will clear the field value.

Returns:

The effect description.

Throws:

IllegalArgumentException - if the given custom field is not a number field.

setDateCustomField

@NotNull
public static StoredEffect setDateCustomField(@NotNull
                                                       Issue issue,
                                                       @NotNull
                                                       CustomField customField,
                                                       @Nullable
                                                       Date value)

Returns a description of an effect that would set a date custom field to the given value. The inverse effect would restore the value that the given issue had when the effect was applied.

Parameters:

issue - The issue.

customField - The custom field, must be a date custom field.

value - The date value to set. Passing null will clear the field value.

Returns:

The effect description.

Throws:

IllegalArgumentException - if the given custom field is not a date field.

setDateTimeCustomField

@NotNull
public static StoredEffect setDateTimeCustomField(@NotNull
                                                           Issue issue,
                                                           @NotNull
                                                           CustomField customField,
                                                           @Nullable
                                                           Date value)

Returns a description of an effect that would set a date time custom field to the given value. The inverse effect would restore the value that the given issue had when the effect was applied.

Parameters:

issue - The issue.

customField - The custom field, must be a date time custom field.

value - The text value to set. Passing null will clear the field value.

Returns:

The effect description.

Throws:

IllegalArgumentException - if the given custom field is not a date time field.

setCascadeCustomField

@NotNull
public static StoredEffect setCascadeCustomField(@NotNull
                                                          Issue issue,
                                                          @NotNull
                                                          CustomField customField,
                                                          @Nullable
                                                          Option value)

Returns a description of an effect that would set a cascading select custom field to the given option. The inverse effect would restore the value that the given issue had when the effect was applied.

Parameters:

issue - The issue.

customField - The custom field, must be a cascading select custom field.

value - The option to set. Can be a parent or a child option. Passing null will clear the field value.

Returns:

The effect description.

Throws:

IllegalArgumentException - if the given custom field is not a cascading select field.