com.atlassian.jira.issue
Interface Issue

All Superinterfaces:
IssueContext, OfBizValueWrapper
All Known Subinterfaces:
MutableIssue
All Known Implementing Classes:
AbstractIssue, DocumentIssueImpl, IssueImpl, TemplateIssue

public interface Issue
extends OfBizValueWrapper, IssueContext

Main issue interface. Historically, JIRA has just passed around GenericValues 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.


Method Summary
 java.util.Collection<Version> getAffectedVersions()
           
 com.opensymphony.user.User getAssignee()
           
 java.lang.String getAssigneeId()
           
 java.util.Collection<Attachment> getAttachments()
           
 java.util.Collection<ProjectComponent> getComponentObjects()
           
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getComponents()
           
 java.sql.Timestamp getCreated()
           
 java.lang.Object getCustomFieldValue(CustomField customField)
           
 java.lang.String getDescription()
           
 java.sql.Timestamp getDueDate()
           
 java.lang.String getEnvironment()
           
 java.lang.Long getEstimate()
          This is the "remaining estimate" of work left to be performed on this issue, in milliseconds.
 java.lang.Object getExternalFieldValue(java.lang.String fieldId)
           
 java.util.Collection<Version> getFixVersions()
           
 java.lang.Long getId()
           
 IssueRenderContext getIssueRenderContext()
           
 org.ofbiz.core.entity.GenericValue getIssueType()
          Deprecated. Please use getIssueTypeObject(). Deprecated since v4.0
 IssueType getIssueTypeObject()
          Gets the IssueType for this Issue.
 java.lang.String getKey()
           
 java.util.Set<Label> getLabels()
          Returns a set of all the labels for this issue or an empty set if none exist yet.
 java.lang.Long getOriginalEstimate()
          This is the "original estimate" of work to be performed on this issue, in milliseconds.
 org.ofbiz.core.entity.GenericValue getParent()
          Deprecated. Use getParentObject() instead.
 java.lang.Long getParentId()
           
 Issue getParentObject()
          If this issue is a subtask, return its parent.
 org.ofbiz.core.entity.GenericValue getPriority()
           
 Priority getPriorityObject()
           
 org.ofbiz.core.entity.GenericValue getProject()
          Deprecated. please use getProjectObject (this still implicitly relies on the GV), but it is a start!
 Project getProjectObject()
          Gets the Project for this Issue.
 com.opensymphony.user.User getReporter()
           
 java.lang.String getReporterId()
           
 org.ofbiz.core.entity.GenericValue getResolution()
           
 java.sql.Timestamp getResolutionDate()
          Returns the datetime that an issue was resolved on.
 Resolution getResolutionObject()
           
 org.ofbiz.core.entity.GenericValue getSecurityLevel()
           
 java.lang.Long getSecurityLevelId()
           
 org.ofbiz.core.entity.GenericValue getStatus()
          Deprecated. Use getStatusObject() instead.
 Status getStatusObject()
           
 java.util.Collection<Issue> getSubTaskObjects()
          Gets all the issue's subtasks.
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getSubTasks()
          Deprecated. Use getSubTaskObjects()
 java.lang.String getSummary()
           
 java.lang.Long getTimeSpent()
          This is the "total time spent" working on this issue, in milliseconds.
 java.sql.Timestamp getUpdated()
           
 java.lang.Long getVotes()
           
 java.lang.Long getWorkflowId()
           
 boolean isCreated()
           
 boolean isEditable()
           
 boolean isSubTask()
           
 
Methods inherited from interface com.atlassian.jira.ofbiz.OfBizValueWrapper
getGenericValue, getLong, getString, getTimestamp, store
 

Method Detail

getId

java.lang.Long getId()

getProject

@Deprecated
org.ofbiz.core.entity.GenericValue getProject()
Deprecated. please use getProjectObject (this still implicitly relies on the GV), but it is a start!

Description copied from interface: IssueContext
Gets the Project for this IssueContext.

A null return value is used to represent that this context applies to all Projects.

Specified by:
getProject in interface IssueContext
Returns:
The Project for this IssueContext (can be null).

getProjectObject

Project getProjectObject()
Gets the Project for this Issue.

Specified by:
getProjectObject in interface IssueContext
Returns:
The Project for this Issue.

getIssueType

@Deprecated
org.ofbiz.core.entity.GenericValue getIssueType()
Deprecated. Please use getIssueTypeObject(). Deprecated since v4.0

Gets the IssueType for this Issue.

Specified by:
getIssueType in interface IssueContext
Returns:
The IssueType for this Issue.

getIssueTypeObject

IssueType getIssueTypeObject()
Gets the IssueType for this Issue.

Specified by:
getIssueTypeObject in interface IssueContext
Returns:
The IssueType for this Issue.

getSummary

java.lang.String getSummary()

getAssignee

com.opensymphony.user.User getAssignee()

getAssigneeId

java.lang.String getAssigneeId()

getComponents

java.util.Collection<org.ofbiz.core.entity.GenericValue> getComponents()
Returns:
A collection of component GenericValues.

getComponentObjects

java.util.Collection<ProjectComponent> getComponentObjects()
Returns:
collection of project components (as objects) that this issue is assigned to
Since:
4.2

getReporter

com.opensymphony.user.User getReporter()

getReporterId

java.lang.String getReporterId()

getDescription

java.lang.String getDescription()

getEnvironment

java.lang.String getEnvironment()

getAffectedVersions

java.util.Collection<Version> getAffectedVersions()
Returns:
a collection of 'affects' Version objects.

getFixVersions

java.util.Collection<Version> getFixVersions()
Returns:
a collection of fix-for Version objects.

getDueDate

java.sql.Timestamp getDueDate()

getSecurityLevel

org.ofbiz.core.entity.GenericValue getSecurityLevel()

getSecurityLevelId

java.lang.Long getSecurityLevelId()

getPriority

org.ofbiz.core.entity.GenericValue getPriority()

getPriorityObject

Priority getPriorityObject()

getResolution

org.ofbiz.core.entity.GenericValue getResolution()

getResolutionObject

Resolution getResolutionObject()

getKey

java.lang.String getKey()

getVotes

java.lang.Long getVotes()

getCreated

java.sql.Timestamp getCreated()

getUpdated

java.sql.Timestamp getUpdated()

getResolutionDate

java.sql.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

java.lang.Long getWorkflowId()

getCustomFieldValue

java.lang.Object getCustomFieldValue(CustomField customField)
Returns:
A custom field's value. Will be a List, User, Timestamp etc, depending on custom field type.

getStatus

@Deprecated
org.ofbiz.core.entity.GenericValue getStatus()
Deprecated. Use getStatusObject() instead.


getStatusObject

Status getStatusObject()

getOriginalEstimate

java.lang.Long getOriginalEstimate()
This is the "original estimate" of work to be performed on this issue, in milliseconds.

Returns:
the "original estimate" of work to be performed on this issue, in milliseconds.

getEstimate

java.lang.Long getEstimate()
This is the "remaining estimate" of work left to be performed on this issue, in milliseconds.

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 milliseconds.

getTimeSpent

java.lang.Long getTimeSpent()
This is the "total time spent" working on this issue, in milliseconds.

Returns:
the "total time spent" working on this issue, in milliseconds.

getExternalFieldValue

java.lang.Object getExternalFieldValue(java.lang.String fieldId)

isSubTask

boolean isSubTask()

getParentId

java.lang.Long getParentId()

isCreated

boolean isCreated()

getParentObject

Issue getParentObject()
If this issue is a subtask, return its parent. The parent Issue, or null if the issue is not a subtask.


getParent

@Deprecated
org.ofbiz.core.entity.GenericValue getParent()
Deprecated. Use getParentObject() instead.


getSubTasks

@Deprecated
java.util.Collection<org.ofbiz.core.entity.GenericValue> getSubTasks()
Deprecated. Use getSubTaskObjects()


getSubTaskObjects

java.util.Collection<Issue> getSubTaskObjects()
Gets all the issue's subtasks.

Returns:
A collection of MutableIssues

isEditable

boolean isEditable()

getIssueRenderContext

IssueRenderContext getIssueRenderContext()

getAttachments

java.util.Collection<Attachment> getAttachments()
Returns:
A collection of Attachment objects

getLabels

java.util.Set<Label> 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


Copyright © 2002-2010 Atlassian. All Rights Reserved.