Interface Issue
- All Superinterfaces:
IssueContext
,OfBizValueWrapper
,Serializable
,WithId
,WithKey
- All Known Subinterfaces:
MutableIssue
- All Known Implementing Classes:
AbstractIssue
,DocumentIssueImpl
,GenericIssueWrapper
,GenericMutableIssueWrapper
,IssueImpl
,MockIssue
,RenderParameterHoldingIssueWrapper
,TemplateIssue
GenericValue
s describing issue records. Issue
is essentially a GenericValue wrapper, with setters, getters and a OfBizValueWrapper.store()
operation for persisting changes
through the underlying GenericValue.
Amongst other means, Issue objects may be obtained with IssueManager.getIssueObject(String)
, or converted
using IssueFactory
.
-
Field Summary
Fields inherited from interface com.atlassian.jira.issue.context.IssueContext
GLOBAL
Fields inherited from interface com.atlassian.jira.entity.WithId
ID_COMPARATOR
-
Method Summary
Modifier and TypeMethodDescriptionboolean
For interactivity, implementations must be based on the issue key.Returns the userid of user who archived this issue, or null if it wasn't archived.Returns the user who archived this issue, or null if it wasn't archived.Returns the timestamp when this issue was archived, or null if it wasn't archived.Returns the Assignee User.Returns the Assignee User.Deprecated.getCustomFieldValue
(CustomField customField) This is the "remaining estimate" of work left to be performed on this issue, in seconds.getExternalFieldValue
(String fieldId) org.ofbiz.core.entity.GenericValue
Deprecated.Use the Data object getters instead.getId()
Gets the IssueType for this Issue.Gets the ID of the IssueType for this Issue.Deprecated.Please usegetIssueType()
.getKey()
Returns a set of all the labels for this issue or an empty set if none exist yet.This is the "original estimate" of work to be performed on this issue, in seconds.org.ofbiz.core.entity.GenericValue
Deprecated.UsegetParentObject()
instead.If this issue is a subtask, return its parent.Returns the Priority for this Issue.Deprecated.UsegetPriority()
instead.org.ofbiz.core.entity.GenericValue
Deprecated.please use getProjectObject (this still implicitly relies on the GV), but it is a start!Gets the ID of the Project for this Issue.Gets the Project for this Issue.Returns the Reporter User.Returns the Reporter User.Returns the Resolution for this Issue.Returns the datetime that an issue was resolved on.Deprecated.UsegetResolution()
instead.org.ofbiz.core.entity.GenericValue
Deprecated.UsegetSecurityLevelId()
instead.Returns the Security Level for this Issue.Deprecated.since 7.0.Gets all the issue's subtasks.Collection<org.ofbiz.core.entity.GenericValue>
Deprecated.This is the "total time spent" working on this issue, in seconds.getVotes()
int
hashCode()
For interactivity, implementations must be based on the hashcode of the issue key.boolean
Returns true if issue is archivedboolean
boolean
boolean
Methods inherited from interface com.atlassian.jira.ofbiz.OfBizValueWrapper
getLong, getString, getTimestamp, store
-
Method Details
-
getId
Long getId() -
getProject
Deprecated.please use getProjectObject (this still implicitly relies on the GV), but it is a start! -
getProjectObject
Project getProjectObject()Gets the Project for this Issue.- Specified by:
getProjectObject
in interfaceIssueContext
- Returns:
- The Project for this Issue.
-
getProjectId
Long getProjectId()Gets the ID of the Project for this Issue.- Specified by:
getProjectId
in interfaceIssueContext
- Returns:
- The ID of the Project for this Issue.
-
getIssueType
IssueType getIssueType()Gets the IssueType for this Issue.- Specified by:
getIssueType
in interfaceIssueContext
- Returns:
- The IssueType for this Issue.
-
getIssueTypeObject
Deprecated.Please usegetIssueType()
. Deprecated since v7.0Gets the IssueType for this Issue.- Specified by:
getIssueTypeObject
in interfaceIssueContext
- Returns:
- The IssueType for this Issue.
-
getIssueTypeId
String getIssueTypeId()Gets the ID of the IssueType for this Issue.- Specified by:
getIssueTypeId
in interfaceIssueContext
- Returns:
- The ID of the IssueType for this Issue.
-
getSummary
String getSummary() -
getAssigneeUser
ApplicationUser getAssigneeUser()Returns the Assignee User.If there is no assignee it returns null, else it is guaranteed to return a non-null User. If the User is no longer available, it will create a dummy User object based on the username.
Legacy synonym for
getAssignee()
- Returns:
- the Assignee User.
- Since:
- 4.3
- See Also:
-
getAssignee
@IncompatibleReturnType(since="5.0", was="com.opensymphony.user.User") ApplicationUser getAssignee()Returns the Assignee User.Warning: previous incarnations of this method returned
com.opensymphony.user.User
. This class has now been removed from the JIRA API, meaning that the 5.0 version is not binary or source compatible with earlier versions.- Returns:
- the Assignee User.
-
getAssigneeId
String getAssigneeId()- Returns:
- a user key of the assignee
-
getComponentObjects
Deprecated.UsegetComponents()
. Since v7.0- Returns:
- collection of project components (as objects) that this issue is assigned to
- Since:
- 4.2
-
getComponents
Collection<ProjectComponent> getComponents()- Returns:
- collection of project components (as objects) that this issue is assigned to
- Since:
- 4.2
-
getReporterUser
ApplicationUser getReporterUser()Returns the Reporter User.This will return a non-null User object even if the User has been deleted.
Legacy synonym for
getReporter()
.- Returns:
- the Reporter User.
- Since:
- 4.3
- See Also:
-
getReporter
@IncompatibleReturnType(since="5.0", was="com.opensymphony.user.User") ApplicationUser getReporter()Returns the Reporter User.Warning: previous incarnations of this method returned
com.opensymphony.user.User
. This class has now been removed from the JIRA API, meaning that the 5.0 version is not binary or source compatible with earlier versions.- Returns:
- the Reporter User.
-
getReporterId
String getReporterId()- Returns:
- a user key of the reporter
-
getCreator
ApplicationUser getCreator() -
getCreatorId
String getCreatorId()- Returns:
- a user key of the creator
-
getDescription
String getDescription() -
getEnvironment
String getEnvironment() -
getAffectedVersions
Collection<Version> getAffectedVersions()- Returns:
- a collection of 'affects'
Version
objects.
-
getFixVersions
Collection<Version> getFixVersions()- Returns:
- a collection of fix-for
Version
objects.
-
getDueDate
Timestamp getDueDate() -
getSecurityLevel
Deprecated.UsegetSecurityLevelId()
instead. Since v5.2.Returns the Security Level for this Issue.- Returns:
- the Security Level for this Issue.
-
getSecurityLevelId
Long getSecurityLevelId()Returns the Security Level for this Issue.- Returns:
- the Security Level for this Issue.
-
getPriority
Returns the Priority for this Issue.- Returns:
- the Priority for this Issue.
-
getPriorityObject
Deprecated.UsegetPriority()
instead. Since v7.0Returns the Priority for this Issue.- Returns:
- the Priority for this Issue.
-
getResolutionId
String getResolutionId() -
getResolution
Resolution getResolution()Returns the Resolution for this Issue.- Returns:
- the Resolution for this Issue.
-
getResolutionObject
Deprecated.UsegetResolution()
instead. Since v7.0Returns the Resolution for this Issue.- Returns:
- the Resolution for this Issue.
-
getKey
String getKey() -
getNumber
Long getNumber() -
getVotes
Long getVotes() -
getWatches
Long getWatches() -
getCreated
Timestamp getCreated() -
getUpdated
Timestamp getUpdated() -
getResolutionDate
Timestamp getResolutionDate()Returns the datetime that an issue was resolved on. Will be null if it hasn't been resolved yet, or if an issue has been returned to the 'unresolved' state.- Returns:
- Timestamp of when an issue was resolved, or null
-
getWorkflowId
Long getWorkflowId() -
getCustomFieldValue
- Parameters:
customField
- the CustomField- Returns:
- A custom field's value. Will be a List, User, Timestamp etc, depending on custom field type.
-
getStatus
Status getStatus() -
getStatusId
String getStatusId() -
getStatusObject
Deprecated.since 7.0. UsegetStatus()
instead. -
getOriginalEstimate
Long getOriginalEstimate()This is the "original estimate" of work to be performed on this issue, in seconds.- Returns:
- the "original estimate" of work to be performed on this issue, in seconds.
-
getEstimate
Long getEstimate()This is the "remaining estimate" of work left to be performed on this issue, in seconds.A better name would be getRemainingEstimate but for historical reasons it is called what it is called.
- Returns:
- the "remaining estimate" of work left to be performed on this issue, in seconds.
-
getTimeSpent
Long getTimeSpent()This is the "total time spent" working on this issue, in seconds.- Returns:
- the "total time spent" working on this issue, in seconds.
-
getExternalFieldValue
-
isSubTask
boolean isSubTask() -
getParentId
Long getParentId() -
isCreated
boolean isCreated() -
getParentObject
Issue getParentObject()If this issue is a subtask, return its parent.- Returns:
- The parent Issue, or null if the issue is not a subtask.
-
getParent
Deprecated.UsegetParentObject()
instead. -
getSubTasks
Deprecated. -
getSubTaskObjects
Collection<Issue> getSubTaskObjects()Gets all the issue's subtasks.- Returns:
- A collection of
MutableIssue
s
-
isEditable
boolean isEditable() -
getIssueRenderContext
IssueRenderContext getIssueRenderContext() -
getAttachments
Collection<Attachment> getAttachments()- Returns:
- A collection of
Attachment
objects
-
getLabels
Returns a set of all the labels for this issue or an empty set if none exist yet.- Returns:
- a set of all the labels for this issue or an empty set if none exist yet
-
isArchived
boolean isArchived()Returns true if issue is archived- Returns:
- is issue archived
-
getArchivedByUser
Returns the user who archived this issue, or null if it wasn't archived.- Returns:
- the user who archived this issue, or null if it wasn't archived.
-
getArchivedById
Returns the userid of user who archived this issue, or null if it wasn't archived.- Returns:
- the userid of user who archived this issue, or null if it wasn't archived.
-
getArchivedDate
Returns the timestamp when this issue was archived, or null if it wasn't archived.- Returns:
- timestamp when this issue was archived, or null if it wasn't archived.
-
equals
For interactivity, implementations must be based on the issue key. See the implementation in AbstractIssue for an example. -
hashCode
int hashCode()For interactivity, implementations must be based on the hashcode of the issue key. See the implementation in AbstractIssue for an example. -
getGenericValue
Deprecated.Use the Data object getters instead. Since v5.0.Get the backing GenericValue object.- Specified by:
getGenericValue
in interfaceOfBizValueWrapper
- Returns:
- the backing GenericValue object.
-
getComponents()
.