com.atlassian.jira.issue.MutableIssue |
![]() |
Clients of @PublicApi
can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicApi
as per each product's API policy as long as the client does not implement/extend
@PublicApi
interfaces or classes (refer to each product's API policy for the exact
guarantee---usually binary compatibility is guaranteed at least across minor versions).
@PublicApi
interfaces and classes are not designed to be implemented or extended by clients,
we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not
affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces
annotated with @PublicSpi
are safe to extend/implement).
Facade for an issue's GenericValue. After calling any 'setter' method, you will need to call store()
to persist the change to the database. Note that this is a 'shallow' store - only fields directly part of the issue
(in the database schema) are persisted.
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Retrieve a map of issue fields whose values have been set (since object creation or last
resetModifiedFields() call. | |||||||||||
Reset the internal list of modified fields.
| |||||||||||
Sets the user that this issue is assigned to.
| |||||||||||
Sets the components for this Issue.
| |||||||||||
Sets a custom field value on this Issue Object, but does not write it to the database.
| |||||||||||
This can be used bya field to "place" a custom object into the MutableIssue so that it can be retrieved by key at
a later point via the
getModifiedFields() and getExternalFieldValue(String) . | |||||||||||
This can be used by a field to "place" a custom object into the MutableIssue so that it can be retrieved by key at
a later point via the
getModifiedFields() and getExternalFieldValue(String) . | |||||||||||
Sets the IssueType for this Issue.
| |||||||||||
This method is deprecated.
Use
setProjectObject(com.atlassian.jira.project.Project) and setNumber(Long) to change issue. Since v6.1
| |||||||||||
Set the labels for this issue.
| |||||||||||
Sets the ParentId of this Issue.
| |||||||||||
Sets the parent Issue Object for this Issue (subtask).
| |||||||||||
Sets the priority for this Issue.
| |||||||||||
Sets the priority for this Issue.
| |||||||||||
Sets the priority for this Issue.
| |||||||||||
This method is deprecated.
Use
setProjectObject(com.atlassian.jira.project.Project) instead. Since v5.0.
| |||||||||||
Sets the project by id.
| |||||||||||
Sets the Project for this Issue.
| |||||||||||
Sets the reporter in this issue.
| |||||||||||
Sets the resolution for this Issue.
| |||||||||||
Sets the resolution for this Issue.
| |||||||||||
This method is deprecated.
Use
setSecurityLevelId(Long) instead. Since v5.0.
| |||||||||||
Sets the SecurityLevel for this Issue.
| |||||||||||
Sets the status for this Issue.
| |||||||||||
Set issue's status by status id ("1", "2" etc).
| |||||||||||
Sets the status for this Issue.
| |||||||||||
This method is deprecated.
Use the Object's Service or Manager to save values. Since v5.0.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Retrieve a map of issue fields whose values have been set (since object creation or last resetModifiedFields()
call.
IssueFieldConstants
and the value
objects in the ModifiedValue are field-specific.
Reset the internal list of modified fields.
affectedVersions | A collection of 'affects' Version objects.
|
---|
Sets the user that this issue is assigned to. Note that this should be the userkey, not the username.
assigneeId | The user key. |
---|
Sets the components for this Issue.
components | the new components value |
---|
Sets a custom field value on this Issue Object, but does not write it to the database. This is highly
misleading.
To actually set a custom field value, use updateIssue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, MutableIssue, java.util.Map)
customField | the CustomField |
---|---|
value | the value. |
This can be used bya field to "place" a custom object into the MutableIssue so that it can be retrieved by key at
a later point via the getModifiedFields()
and getExternalFieldValue(String)
.
The passed in newValue will be wrapped in the getNewValue()
and the oldValue will be placed
in getOldValue()
fieldId | the field id to use as a key |
---|---|
oldValue | the old value to place in a ModifiedValue |
newValue | the new value to place in a ModifiedValue
|
This can be used by a field to "place" a custom object into the MutableIssue so that it can be retrieved by key at
a later point via the getModifiedFields()
and getExternalFieldValue(String)
.
The passed in newValue will be wrapped in the getNewValue()
The getOldValue()
will be null.
fieldId | the field id to use as a key |
---|---|
newValue | the new value to place in a ModifiedValue
|
fixVersions | A collection of fix-for Version objects.
|
---|
Sets the IssueType for this Issue.
issueType | the new IssueType |
---|
This method is deprecated.
Use setProjectObject(com.atlassian.jira.project.Project)
and setNumber(Long)
to change issue. Since v6.1
Set the labels for this issue.
labels | the labels for this issue |
---|
Sets the ParentId of this Issue.
parentId | The new parentId. |
---|
Sets the parent Issue Object for this Issue (subtask).
Normally a subtask just has the ID of the parent set
using setParentId()
. In this case, the getParentObject() method will look up the parent object from
the DB (or cache). However, when you are editing a parent and its subtask within a transaction (eg a Bulk Move),
it is useful to be able to link the subtask to the pending parent object in order that it can see the
new values for the parent.
parentIssue | the required parent Issue for this subtask. |
---|
Sets the priority for this Issue.
priority | the new priority value |
---|
Sets the priority for this Issue.
priorityId | the new priority value |
---|
Sets the priority for this Issue.
priority | the new priority value |
---|
This method is deprecated.
Use setProjectObject(com.atlassian.jira.project.Project)
instead. Since v5.0.
Sets the Project for this Issue.
project | the new Project |
---|
Sets the project by id.
projectId | The id of the project |
---|
IllegalArgumentException | If no project exists for the given projectId. |
---|
Sets the Project for this Issue.
project | the new Project |
---|
Sets the reporter in this issue. Note that this should be the userkey, not the username.
reporterId | userkey of the desired reporter. |
---|
Sets the resolution for this Issue.
resolution | the new resolution value |
---|
This method is deprecated.
Use setSecurityLevelId(Long)
instead. Since v5.0.
Sets the SecurityLevel for this Issue.
securityLevel | the new SecurityLevel value |
---|
Sets the SecurityLevel for this Issue.
securityLevelId | the new SecurityLevel value |
---|
Sets the status for this Issue.
status | the new status value |
---|
Set issue's status by status id ("1", "2" etc).
statusId | the new StatusId. |
---|
Sets the status for this Issue.
status | the new status value |
---|
@Internal
classes and interfaces can not expect to be compatible with any version
other than the version they were compiled against (even minor version and milestone releases may break binary
compatibility with respect to @Internal
elements).
This method is deprecated.
Use the Object's Service or Manager to save values. Since v5.0.
Persist this issue's immediate fields. This is for internal usage only.