abstract class AbstractIssuesDelegate extends java.lang.Object
Modifiers | Name | Description |
---|---|---|
static java.lang.String |
APPLICATION_OCTET_STREAM_VALUE |
|
protected com.atlassian.jira.issue.fields.FieldManager |
fieldManager |
|
protected com.atlassian.jira.issue.Issue |
issue |
|
protected com.atlassian.jira.issue.IssueInputParameters |
issueInputParameters |
Constructor and description |
---|
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) |
Type Params | Return Type | Name and description |
---|---|---|
|
void |
addAttachment(java.lang.String path) Adds a new attachment from the provided full path to a file. |
|
void |
addAttachment(java.io.File file) Adds a new attachment from the provided file. |
|
void |
clearCustomField(java.lang.Long fieldId) Clear a custom field value |
|
void |
clearCustomField(java.lang.String fieldName) Clear a custom field value |
|
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) |
<T> |
T |
issueInputParameters(groovy.lang.Closure<T> specification) |
|
void |
setAffectedVersions(java.lang.String[] versionNames) Sets the affected versions on the issue |
|
void |
setAffectedVersions(com.atlassian.jira.project.version.Version[] versions) Sets the affected versions on the issue. |
|
void |
setAffectedVersions(groovy.lang.Closure<?> specification) Sets the affected versions on the issue |
|
void |
setApplyDefaultValuesWhenParameterNotProvided(boolean skip) Whether to apply default value if a parameter has not been provided |
|
void |
setAssignee(groovy.lang.Closure<?> specification) Sets the assignee of the issue |
|
void |
setAssignee(java.lang.String username) Sets the assignee of the issue |
|
void |
setAssignee(com.atlassian.jira.user.ApplicationUser applicationUser) Sets the assignee of the issue |
|
void |
setComponents(java.lang.String[] componentNames) Sets the components on the issue |
|
void |
setComponents(com.atlassian.jira.bc.project.component.ProjectComponent[] components) Sets the components on the issue |
|
void |
setComponents(groovy.lang.Closure<?> specification) Sets the components on the issue |
|
void |
setCustomFieldValue(java.lang.String fieldName, java.lang.String[] strings) Set a custom field value on the issue |
|
void |
setCustomFieldValue(java.lang.String fieldName, java.lang.Long[] longs) Set a custom field value on the issue |
|
void |
setCustomFieldValue(java.lang.String fieldName, java.lang.Object[] objects) Set a custom field value on the issue |
|
void |
setCustomFieldValue(java.lang.Long fieldId, java.lang.String[] strings) Set a custom field value on the issue |
|
void |
setCustomFieldValue(java.lang.Long fieldId, java.lang.Long[] longs) Set a custom field value on the issue |
|
void |
setCustomFieldValue(java.lang.Long fieldId, java.lang.Object[] objects) Set a custom field value on the issue |
|
void |
setCustomFieldValue(java.lang.String fieldId, java.lang.Class<? extends FieldUpdater> updaterType, groovy.lang.Closure specification) Set a custom field value on the issue Recommended for internal use only. |
|
void |
setCustomFieldValue(java.lang.Long fieldId, java.lang.Class<? extends FieldUpdater> updaterType, groovy.lang.Closure specification) Set a custom field value on the issue Recommended for internal use only. |
|
void |
setCustomFieldValue(java.lang.Long fieldId, groovy.lang.Closure<?> specification) Set a custom field value on the issue |
|
void |
setCustomFieldValue(com.atlassian.jira.issue.fields.Field field, groovy.lang.Closure<?> specification) Set a custom field value on the issue |
|
void |
setCustomFieldValue(java.lang.String fieldName, groovy.lang.Closure<?> specification) Set a custom field value on the issue |
|
void |
setCustomFieldValueById(java.lang.String fieldName, java.lang.Long[] longs) Set a custom field value on the issue |
|
void |
setDescription(java.lang.String description) Sets the description of the issue |
|
void |
setDescription(groovy.lang.Closure<?> specification) Sets the description of the issue |
|
void |
setDueDate(java.lang.String date) Sets a formatted string that Jira will accept as a date to be set on the issue. |
|
void |
setDueDate(groovy.lang.Closure<?> specification) Set the due date of the issue |
|
void |
setEnvironment(java.lang.String environment) Sets the environment field of the issue |
|
void |
setEnvironment(groovy.lang.Closure<?> specification) Sets the environment field of the issue |
|
void |
setFixVersions(java.lang.String[] versionNames) Sets the fix versions on the issue |
|
void |
setFixVersions(groovy.lang.Closure<?> specification) Sets the fix versions on the issue |
|
void |
setFixVersions(java.lang.Long[] ids) Sets the fix versions on the issue |
|
void |
setFixVersions(com.atlassian.jira.project.version.Version[] versions) Sets the fix versions on the issue |
|
void |
setLabels(java.lang.String[] labels) Sets the labels on the issue |
|
void |
setLabels(groovy.lang.Closure<?> specification) Sets the labels on the issue |
|
void |
setLinks(java.lang.String linkDirection, java.lang.String[] issueKeys) Set links on the issue |
|
void |
setLinks(java.lang.String linkDirection, com.atlassian.jira.issue.Issue[] issues) Set links on the issue |
|
void |
setOriginalAndRemainingEstimate(java.lang.Long originalEstimate, java.lang.Long remainingEstimate) Sets the original estimate and the remaining estimate. |
|
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 |
|
void |
setOriginalEstimate(java.lang.Long originalEstimate) Sets the new original estimate. |
|
void |
setOriginalEstimate(java.lang.String originalEstimate) Sets the original estimate, e.g. "1d 5h" for 1 day and 5 hours |
|
void |
setPriority(java.lang.String priorityName) Sets the priority of the issue |
|
void |
setPriority(com.atlassian.jira.issue.priority.Priority priority) Sets the priority of the issue |
|
void |
setRemainingEstimate(java.lang.Long remainingEstimate) Sets the remaining estimate. |
|
void |
setRemainingEstimate(java.lang.String remainingEstimate) Sets the remaining estimate e.g. "1d 5h" for 1 day and 5 hours |
|
void |
setReporter(groovy.lang.Closure<?> specification) Sets the reporter of the issue |
|
void |
setReporter(java.lang.String username) Sets the reporter of the issue |
|
void |
setReporter(com.atlassian.jira.user.ApplicationUser applicationUser) Sets the reporter of the issue |
|
void |
setRequestChannel(java.lang.String channel) Sets the Jira Service Management request channel |
|
void |
setSecurityLevel(java.lang.String issueSecurityLevelName) Sets the security level of the issue |
|
void |
setSecurityLevel(com.atlassian.jira.issue.security.IssueSecurityLevel issueSecurityLevel) Sets the security level of the issue |
|
void |
setSkipScreenCheck(boolean skip) Whether to check if the field is present on the screen |
|
void |
setSummary(java.lang.String summary) Sets the summary of the issue |
|
void |
setSummary(groovy.lang.Closure<?> specification) Sets the summary of the issue |
|
void |
setTimeSpent(java.lang.Long timeSpent) Sets the time spent on the issue |
|
void |
updateIssueInputParameters(java.lang.String fieldId, groovy.lang.Closure<?> specification) |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Adds a new attachment from the provided full path to a file. Call this method multiple times if you wish to add multiple attachments.
file
- the full path to a file to attach accessible from the Jira serverAdds a new attachment from the provided file. Call this method multiple times if you wish to add multiple attachments.
file
- the file to attachClear a custom field value
fieldId
- id of the fieldClear a custom field value
fieldName
- name of the fieldSets the affected versions on the issue
versionNames
- names of the versionsSets the affected versions on the issue.
Sets the affected versions on the issue
specification
- closure allowing fine control of updates, e.g. adding and replacingWhether to apply default value if a parameter has not been provided
skip
- true if default value should be supplied when a parameter has not been provided, false if the default value should not be applied.Sets the assignee of the issue
specification
- closure allowing fine control of updates, e.g. replacingSets the assignee of the issue
username
- username of the assigneeSets the assignee of the issue
Sets the components on the issue
componentNames
- names of the componentsSets the components on the issue
Sets the components on the issue
specification
- closure allowing fine control of updates, e.g. adding and replacingSet a custom field value on the issue
fieldName
- name of the fieldstrings
- string values to setSet a custom field value on the issue
fieldName
- name of the fieldlongs
- ids of the options or a numerical value to setSet a custom field value on the issue
fieldName
- name of the fieldobjects
- objects representing the value to set
Example:
def user = Users.getByName('auser') Issues.getByKey('abc-1').update { setCustomFieldValue('UserPicker', user) }
Set a custom field value on the issue
fieldId
- id of the fieldstrings
- string values to setSet a custom field value on the issue
fieldId
- id of the fieldlongs
- ids of the options or a numerical value to setSet a custom field value on the issue
fieldId
- id of the fieldobjects
- objects representing the value to set
Example:
def user = Users.getByName('auser') Issues.getByKey('abc-1').update { setCustomFieldValue(10001L, user) }
Set a custom field value on the issue Recommended for internal use only. Use AbstractIssuesDelegate.setCustomFieldValue instead.
fieldId
- id of the fieldupdaterType
- FieldUpdater implementation for the relevant field typespecification
- closure allowing fine control of updates, e.g. adding and replacing. Available closure parameters vary depending on field typeSet a custom field value on the issue Recommended for internal use only. Use AbstractIssuesDelegate.setCustomFieldValue instead.
fieldId
- id of the fieldupdaterType
- FieldUpdater implementation for the relevant field typespecification
- closure allowing fine control of updates, e.g. adding and replacing. Available closure parameters vary depending on field typeSet a custom field value on the issue
fieldId
- id of the fieldspecification
- closure allowing fine control of updates, e.g. adding and replacing. Available closure parameters vary depending on field typeSet a custom field value on the issue
specification
- closure allowing fine control of updates, e.g. adding and replacing. Available closure parameters vary depending on field typeSet a custom field value on the issue
fieldName
- name of the fieldspecification
- closure allowing fine control of updates, e.g. adding and replacing. Available closure parameters vary depending on field typeSet a custom field value on the issue
fieldName
- name of the fieldlongs
- ids of the option values to setSets the description of the issue
Sets the description of the issue
specification
- closure allowing fine control of updates, e.g. replacingSets 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
Set the due date of the issue
specification
- closure containing parameters to *set* an issue's due date with Timestamp or LocalDate objectsSets the environment field of the issue
Sets the environment field of the issue
specification
- closure allowing fine control of updates, e.g. replacingSets the fix versions on the issue
versionNames
- names of the versionsSets the fix versions on the issue
specification
- closure allowing fine control of updates, e.g. adding and replacingSets the fix versions on the issue
ids
- ids of the versionsSets the fix versions on the issue
Sets the labels on the issue
Sets the labels on the issue
specification
- closure allowing fine control of updates, e.g. adding and replacingSet links on the issue
linkDirection
- the link direction name. e.g 'blocks'.issueKeys
- issue keys to be linked to the current issue.Set links on the issue
linkDirection
- the link direction name. e.g 'blocks'.Issue
- objects to be linked to the current issue.Sets the original estimate and the remaining estimate. The units used are determined by JIRA_TIMETRACKING_DEFAULT_UNIT
Sets the original estimate and remaining estimate e.g. "1d 5h" for 1 day and 5 hours
Sets the new original estimate. The units used are determined by JIRA_TIMETRACKING_DEFAULT_UNIT.
Sets the original estimate, e.g. "1d 5h" for 1 day and 5 hours
Sets the priority of the issue
priorityName
- name of the prioritySets the priority of the issue
Sets the remaining estimate. The units used are determined by JIRA_TIMETRACKING_DEFAULT_UNIT
Sets the remaining estimate e.g. "1d 5h" for 1 day and 5 hours
Sets the reporter of the issue
specification
- closure allowing fine control of updates, e.g. replacingSets the reporter of the issue
username
- username of the reporterSets the reporter of the issue
Sets the Jira Service Management request channel
channel
- the channel to set (can be any string)Sets the security level of the issue
issueSecurityLevelName
- name of the security levelSets the security level of the issue
Whether to check if the field is present on the screen
skip
- true to allow a field to be set when it is not on the screen, false to prevent the operationSets the summary of the issue
Sets the summary of the issue
specification
- closure allowing fine control of updates, e.g. replacingSets the time spent on the issue