Field Detail

• public static final java.lang.String APPLICATION_OCTET_STREAM_VALUE

• protected final com.atlassian.jira.issue.fields.FieldManager fieldManager

• protected final com.atlassian.jira.issue.Issue issue

• protected final com.atlassian.jira.issue.IssueInputParameters issueInputParameters

Constructor Detail

• AbstractIssuesDelegate(com.atlassian.jira.issue.Issue issue, com.atlassian.jira.issue.IssueInputParameters issueInputParameters, com.atlassian.jira.config.ConstantsManager constantsManager, com.atlassian.jira.security.PermissionManager permissionManager, com.atlassian.jira.issue.security.IssueSecuritySchemeManager issueSecuritySchemeManager, com.atlassian.jira.issue.attachment.TemporaryWebAttachmentManager temporaryWebAttachmentManager, com.atlassian.jira.security.JiraAuthenticationContext authenticationContext, com.atlassian.jira.issue.security.IssueSecurityLevelManager issueSecurityLevelManager, com.atlassian.jira.security.xsrf.XsrfTokenGenerator xsrfTokenGenerator, com.atlassian.jira.issue.fields.FieldManager fieldManager, FieldUpdaterResolver fieldUpdaterResolver, AttachmentFileValidator attachmentFileValidator)

Method Detail

• void addAttachment(java.lang.String path)

  Adds a new attachment from the provided full path to a file. Call this method multiple times if you wish to add multiple attachments.

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.TemporaryAttachmentCreationException if the user does have permission to create attachments

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.AttachmentCreationException if there is a problem with the file, such as not being found, or too large

  Parameters:

  file - the full path to a file to attach accessible from the Jira server

  See Also:

  Work with attachments

• void addAttachment(java.io.File file)

  Adds a new attachment from the provided file. Call this method multiple times if you wish to add multiple attachments.

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.TemporaryAttachmentCreationException if the user does have permission to create attachments

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.AttachmentCreationException if there is a problem with the file, such as not being found, or too large

  Parameters:

  file - the file to attach

  See Also:

  Work with attachments

• void clearCustomField(java.lang.Long fieldId)

  Clear a custom field value

  Parameters:

  fieldId - id of the field

• void clearCustomField(java.lang.String fieldName)

  Clear a custom field value

  Parameters:

  fieldName - name of the field

• protected void dispose()

• protected abstract io.atlassian.fugue.Either<com.atlassian.jira.issue.Issue, com.atlassian.jira.project.Project> getAttachmentTarget()

• protected java.util.Map<java.lang.String, java.lang.Object> getCurrentValue(java.lang.String fieldId)

• com.atlassian.jira.issue.context.IssueContext getIssueContext()

• <T> T issueInputParameters(@groovy.lang.DelegatesTo(strategy: DELEGATE_FIRST, value: IssueInputParameters)
  groovy.lang.Closure<T> specification)

• void setAffectedVersions(java.lang.String[] versionNames)

  Sets the affected versions on the issue

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.InvalidVersionException when trying to set an invalid or null version

  Parameters:

  versionNames - names of the versions

• void setAffectedVersions(com.atlassian.jira.project.version.Version[] versions)

  Sets the affected versions on the issue.

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.InvalidVersionException when trying to set an invalid or null version

  Parameters:

  versions

• void setAffectedVersions(@groovy.lang.DelegatesTo(value: MultipleVersionUpdater)
  groovy.lang.Closure<?> specification)

  Sets the affected versions on the issue

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.InvalidVersionException when trying to set an invalid or null version

  Parameters:

  specification - closure allowing fine control of updates, e.g. adding and replacing

  See Also:

  Updating options, versions and component fields

• void setApplyDefaultValuesWhenParameterNotProvided(boolean skip)

  Whether to apply default value if a parameter has not been provided

  Parameters:

  skip - true if default value should be supplied when a parameter has not been provided, false if the default value should not be applied.

• void setAssignee(@groovy.lang.DelegatesTo(value: AssigneeUpdater)
  groovy.lang.Closure<?> specification)

  Sets the assignee of the issue

  Parameters:

  specification - closure allowing fine control of updates, e.g. replacing

  See Also:

  Setting user fields

• void setAssignee(java.lang.String username)

  Sets the assignee of the issue

  Parameters:

  username - username of the assignee

• void setAssignee(com.atlassian.jira.user.ApplicationUser applicationUser)

  Sets the assignee of the issue

  Parameters:

  applicationUser

• void setComponents(java.lang.String[] componentNames)

  Sets the components on the issue

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.InvalidComponentException when trying to set an invalid or null Project Component

  Parameters:

  componentNames - names of the components

• void setComponents(com.atlassian.jira.bc.project.component.ProjectComponent[] components)

  Sets the components on the issue

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.InvalidComponentException when trying to set an invalid or null Project Component

  Parameters:

  components

• void setComponents(@groovy.lang.DelegatesTo(value: ProjectComponentsUpdater)
  groovy.lang.Closure<?> specification)

  Sets the components on the issue

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.InvalidComponentException when trying to set an invalid or null component

  Parameters:

  specification - closure allowing fine control of updates, e.g. adding and replacing

  See Also:

  Updating options, versions and component fields

• void setCustomFieldValue(java.lang.String fieldName, java.lang.String[] strings)

  Set a custom field value on the issue

  Parameters:

  fieldName - name of the field

  strings - string values to set

  See Also:

  Update fields

• void setCustomFieldValue(java.lang.String fieldName, java.lang.Long[] longs)

  Set a custom field value on the issue

  Parameters:

  fieldName - name of the field

  longs - ids of the options or a numerical value to set

  See Also:

  Update fields

• void setCustomFieldValue(java.lang.String fieldName, java.lang.Object[] objects)

  Set a custom field value on the issue

  Parameters:

  fieldName - name of the field

  objects - objects representing the value to set

  Example:

   def user = Users.getByName('auser')
  
   Issues.getByKey('abc-1').update {
        setCustomFieldValue('UserPicker', user)
   }
   

  See Also:

  • void setCustomFieldValue(java.lang.Long fieldId, java.lang.String[] strings)

    Set a custom field value on the issue

    Parameters:

    fieldId - id of the field

    strings - string values to set

    See Also:

    Update fields

  • void setCustomFieldValue(java.lang.Long fieldId, java.lang.Long[] longs)

    Set a custom field value on the issue

    Parameters:

    fieldId - id of the field

    longs - ids of the options or a numerical value to set

    See Also:

    Update fields

  • void setCustomFieldValue(java.lang.Long fieldId, java.lang.Object[] objects)

    Set a custom field value on the issue

    Parameters:

    fieldId - id of the field

    objects - objects representing the value to set

    Example:

     def user = Users.getByName('auser')
    
     Issues.getByKey('abc-1').update {
          setCustomFieldValue(10001L, user)
     }
     

    See Also:

    Update fields

  • @java.lang.SuppressWarnings(value: unused)
    void setCustomFieldValue(java.lang.String fieldId, @DelegatesTo.Target
    java.lang.Class<? extends FieldUpdater> updaterType, @groovy.lang.DelegatesTo(genericTypeIndex: 0, value: DelegatesTo.Target)
    groovy.lang.Closure specification)

    Set a custom field value on the issue Recommended for internal use only. Use AbstractIssuesDelegate.setCustomFieldValue instead.

    Parameters:

    fieldId - id of the field

    updaterType - FieldUpdater implementation for the relevant field type

    specification - closure allowing fine control of updates, e.g. adding and replacing. Available closure parameters vary depending on field type

    See Also:

    Update fields

  • @java.lang.SuppressWarnings(value: unused)
    void setCustomFieldValue(java.lang.Long fieldId, @DelegatesTo.Target
    java.lang.Class<? extends FieldUpdater> updaterType, @groovy.lang.DelegatesTo(genericTypeIndex: 0, value: DelegatesTo.Target)
    groovy.lang.Closure specification)

    Set a custom field value on the issue Recommended for internal use only. Use AbstractIssuesDelegate.setCustomFieldValue instead.

    Parameters:

    fieldId - id of the field

    updaterType - FieldUpdater implementation for the relevant field type

    specification - closure allowing fine control of updates, e.g. adding and replacing. Available closure parameters vary depending on field type

    See Also:

    Update fields

  • void setCustomFieldValue(java.lang.Long fieldId, groovy.lang.Closure<?> specification)

    Set a custom field value on the issue

    Parameters:

    fieldId - id of the field

    specification - closure allowing fine control of updates, e.g. adding and replacing. Available closure parameters vary depending on field type

    See Also:

    Update fields

  • void setCustomFieldValue(com.atlassian.jira.issue.fields.Field field, groovy.lang.Closure<?> specification)

    Set a custom field value on the issue

    Parameters:

    field

    specification - closure allowing fine control of updates, e.g. adding and replacing. Available closure parameters vary depending on field type

    See Also:

    Update fields

  • void setCustomFieldValue(java.lang.String fieldName, groovy.lang.Closure<?> specification)

    Set a custom field value on the issue

    Parameters:

    fieldName - name of the field

    specification - closure allowing fine control of updates, e.g. adding and replacing. Available closure parameters vary depending on field type

    See Also:

    Update fields

  • void setCustomFieldValueById(java.lang.String fieldName, java.lang.Long[] longs)

    Set a custom field value on the issue

    Parameters:

    fieldName - name of the field

    longs - ids of the option values to set

  • void setDescription(java.lang.String description)

    Sets the description of the issue

    Parameters:

    description

  • void setDescription(@groovy.lang.DelegatesTo(value: StringUpdater)
    groovy.lang.Closure<?> specification)

    Sets the description of the issue

    Parameters:

    specification - closure allowing fine control of updates, e.g. replacing

    See Also:

    Updating text fields

  • void setDueDate(java.lang.String date)

    Sets a formatted string that Jira will accept as a date to be set on the issue.

    The date format is defined in your Jira settings. System > Look and Feel > Date/Time Formats

  • void setDueDate(@groovy.lang.DelegatesTo(value: DateUpdater)
    groovy.lang.Closure<?> specification)

    Set the due date of the issue

    Parameters:

    specification - closure containing parameters to *set* an issue's due date with Timestamp or LocalDate objects

    See Also:

    Update date and date time fields

  • void setEnvironment(java.lang.String environment)

    Sets the environment field of the issue

    Parameters:

    environment

  • void setEnvironment(@groovy.lang.DelegatesTo(value: StringUpdater)
    groovy.lang.Closure<?> specification)

    Sets the environment field of the issue

    Parameters:

    specification - closure allowing fine control of updates, e.g. replacing

    See Also:

    Updating text fields

  • void setFixVersions(java.lang.String[] versionNames)

    Sets the fix versions on the issue

    throws:

    com.adaptavist.hapi.jira.issues.exceptions.InvalidVersionException when trying to set an invalid or null version

    Parameters:

    versionNames - names of the versions

  • void setFixVersions(@groovy.lang.DelegatesTo(value: MultipleVersionUpdater)
    groovy.lang.Closure<?> specification)

    Sets the fix versions on the issue

    throws:

    com.adaptavist.hapi.jira.issues.exceptions.InvalidVersionException when trying to set an invalid or null version

    Parameters:

    specification - closure allowing fine control of updates, e.g. adding and replacing

    See Also:

    Updating options, versions and component fields

  • void setFixVersions(java.lang.Long[] ids)

    Sets the fix versions on the issue

    throws:

    com.adaptavist.hapi.jira.issues.exceptions.InvalidVersionException when trying to set an invalid or null version

    Parameters:

    ids - ids of the versions

  • void setFixVersions(com.atlassian.jira.project.version.Version[] versions)

    Sets the fix versions on the issue

    throws:

    com.adaptavist.hapi.jira.issues.exceptions.InvalidVersionException when trying to set an invalid or null version

    Parameters:

    versions

  • void setLabels(java.lang.String[] labels)

    Sets the labels on the issue

    Parameters:

    labels

  • void setLabels(@groovy.lang.DelegatesTo(value: LabelsUpdater)
    groovy.lang.Closure<?> specification)

    Sets the labels on the issue

    Parameters:

    specification - closure allowing fine control of updates, e.g. adding and replacing

    See Also:

    Update fields

  • void setLinks(java.lang.String linkDirection, java.lang.String[] issueKeys)

    Set links on the issue

    Parameters:

    linkDirection - the link direction name. e.g 'blocks'.

    issueKeys - issue keys to be linked to the current issue.

  • void setLinks(java.lang.String linkDirection, com.atlassian.jira.issue.Issue[] issues)

    Set links on the issue

    Parameters:

    linkDirection - the link direction name. e.g 'blocks'.

    Issue - objects to be linked to the current issue.

  • void setOriginalAndRemainingEstimate(java.lang.Long originalEstimate, java.lang.Long remainingEstimate)

    Sets the original estimate and the remaining estimate. The units used are determined by JIRA_TIMETRACKING_DEFAULT_UNIT

    Parameters:

    originalEstimate

    remainingEstimate

    See Also:

    JIRA_TIMETRACKING_DEFAULT_UNIT

  • void setOriginalAndRemainingEstimate(java.lang.String originalEstimate, java.lang.String remainingEstimate)

    Sets the original estimate and remaining estimate e.g. "1d 5h" for 1 day and 5 hours

    Parameters:

    originalEstimate

    remainingEstimate

  • void setOriginalEstimate(java.lang.Long originalEstimate)

    Sets the new original estimate. The units used are determined by JIRA_TIMETRACKING_DEFAULT_UNIT.

    Parameters:

    originalEstimate

    See Also:

    JIRA_TIMETRACKING_DEFAULT_UNIT

  • void setOriginalEstimate(java.lang.String originalEstimate)

    Sets the original estimate, e.g. "1d 5h" for 1 day and 5 hours

    Parameters:

    originalEstimate

  • void setPriority(java.lang.String priorityName)

    Sets the priority of the issue

    throws:

    com.adaptavist.hapi.jira.issues.exceptions.InvalidPriorityException

    Parameters:

    priorityName - name of the priority

  • void setPriority(com.atlassian.jira.issue.priority.Priority priority)

    Sets the priority of the issue

    Parameters:

    priority

  • void setRemainingEstimate(java.lang.Long remainingEstimate)

    Sets the remaining estimate. The units used are determined by JIRA_TIMETRACKING_DEFAULT_UNIT

    Parameters:

    remainingEstimate

    See Also:

    JIRA_TIMETRACKING_DEFAULT_UNIT

  • void setRemainingEstimate(java.lang.String remainingEstimate)

    Sets the remaining estimate e.g. "1d 5h" for 1 day and 5 hours

    Parameters:

    remainingEstimate

  • void setReporter(@groovy.lang.DelegatesTo(value: SingleUserUpdater)
    groovy.lang.Closure<?> specification)

    Sets the reporter of the issue

    Parameters:

    specification - closure allowing fine control of updates, e.g. replacing

    See Also:

    Setting user fields

  • void setReporter(java.lang.String username)

    Sets the reporter of the issue

    Parameters:

    username - username of the reporter

  • void setReporter(com.atlassian.jira.user.ApplicationUser applicationUser)

    Sets the reporter of the issue

    Parameters:

    applicationUser

  • void setRequestChannel(java.lang.String channel)

    Sets the Jira Service Management request channel

    Parameters:

    channel - the channel to set (can be any string)

  • void setSecurityLevel(java.lang.String issueSecurityLevelName)

    Sets the security level of the issue

    throws:

    com.adaptavist.hapi.jira.issues.exceptions.PermissionViolationException*

    throws:

    com.adaptavist.hapi.jira.issues.exceptions.InvalidSecurityLevelException

    Parameters:

    issueSecurityLevelName - name of the security level

  • void setSecurityLevel(com.atlassian.jira.issue.security.IssueSecurityLevel issueSecurityLevel)

    Sets the security level of the issue

    throws:

    com.adaptavist.hapi.jira.issues.exceptions.PermissionViolationException*

    throws:

    com.adaptavist.hapi.jira.issues.exceptions.InvalidSecurityLevelException

    Parameters:

    issueSecurityLevel

  • void setSkipScreenCheck(boolean skip)

    Whether to check if the field is present on the screen

    Parameters:

    skip - true to allow a field to be set when it is not on the screen, false to prevent the operation

  • void setSummary(java.lang.String summary)

    Sets the summary of the issue

    Parameters:

    summary

  • void setSummary(@groovy.lang.DelegatesTo(value: StringUpdater)
    groovy.lang.Closure<?> specification)

    Sets the summary of the issue

    Parameters:

    specification - closure allowing fine control of updates, e.g. replacing

    See Also:

    Updating text fields

  • void setTimeSpent(java.lang.Long timeSpent)

    Sets the time spent on the issue

    Parameters:

    timeSpent

  • void updateIssueInputParameters(java.lang.String fieldId, @groovy.lang.DelegatesTo(value: FieldUpdater)
    groovy.lang.Closure<?> specification)