com.atlassian.jira.issue

Class DocumentIssueImpl

java.lang.Object

com.atlassian.jira.issue.AbstractIssue

com.atlassian.jira.issue.DocumentIssueImpl

All Implemented Interfaces:

WithId, WithKey, IssueContext, Issue, OfBizValueWrapper, Serializable

public class DocumentIssueImpl
extends AbstractIssue

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.jira.issue.AbstractIssue

attachmentManager, constantsManager, issueManager

Fields inherited from interface com.atlassian.jira.issue.context.IssueContext

GLOBAL

Fields inherited from interface com.atlassian.jira.entity.WithId

ID_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
DocumentIssueImpl(org.apache.lucene.document.Document document, ConstantsManager constantsManager, FieldManager fieldManager, IssueManager issueManager, IssueFactory issueFactory, AttachmentManager attachmentManager, ProjectFactory projectFactory, JqlLocalDateSupport jqlLocalDateSupport)

Method Summary

Modifier and Type	Method and Description
Collection<Version>	getAffectedVersions()
String	getArchivedById() Returns the userid of user who archived this issue, or null if it wasn't archived.
ApplicationUser	getArchivedByUser() Returns the user who archived this issue, or null if it wasn't archived.
Timestamp	getArchivedDate() Returns the timestamp when this issue was archived, or null if it wasn't archived.
ApplicationUser	getAssignee() Returns the Assignee User.
String	getAssigneeId()
ApplicationUser	getAssigneeUser() Returns the Assignee User.
Collection<ProjectComponent>	getComponentObjects() Deprecated. since 7.0, use getComponents() instead
Collection<ProjectComponent>	getComponents()
Timestamp	getCreated()
ApplicationUser	getCreator()
String	getCreatorId()
Object	getCustomFieldValue(CustomField customField)
String	getDescription()
Timestamp	getDueDate()
String	getEnvironment()
Long	getEstimate() This is the "remaining estimate" of work left to be performed on this issue, in seconds.
Object	getExternalFieldValue(String fieldId)
Collection<Version>	getFixVersions()
org.ofbiz.core.entity.GenericValue	getGenericValue() Get the backing GenericValue object.
Long	getId()
IssueRenderContext	getIssueRenderContext()
IssueType	getIssueType() Gets the IssueType for this Issue.
String	getIssueTypeId() Gets the ID of the IssueType for this Issue.
IssueType	getIssueTypeObject() Gets the IssueType for this Issue.
String	getKey()
Set<Label>	getLabels() Returns a set of all the labels for this issue or an empty set if none exist yet.
Long	getLong(String name) Retrieve a numeric field.
Long	getNumber()
Long	getOriginalEstimate() This is the "original estimate" of work to be performed on this issue, in seconds.
Long	getParentId()
Priority	getPriority() Returns the Priority for this Issue.
Priority	getPriorityObject() Returns the Priority for this Issue.
org.ofbiz.core.entity.GenericValue	getProject()
Long	getProjectId() Gets the ID of the Project for this Issue.
Project	getProjectObject() Gets the Project for this Issue.
ApplicationUser	getReporter() Returns the Reporter User.
String	getReporterId()
ApplicationUser	getReporterUser() Returns the Reporter User.
Resolution	getResolution() Returns the Resolution for this Issue.
Timestamp	getResolutionDate() Returns the datetime that an issue was resolved on.
String	getResolutionId()
Resolution	getResolutionObject() Returns the Resolution for this Issue.
org.ofbiz.core.entity.GenericValue	getSecurityLevel() Returns the Security Level for this Issue.
Long	getSecurityLevelId() Returns the Security Level for this Issue.
Status	getStatus()
String	getStatusId()
Status	getStatusObject()
String	getString(String name) Retrieve a String field.
Collection	getSubTaskObjects() Gets all the issue's subtasks.
Collection	getSubTasks()
String	getSummary()
Long	getTimeSpent() This is the "total time spent" working on this issue, in seconds.
Timestamp	getTimestamp(String name) Retrieve a timestamp field.
Timestamp	getUpdated()
Long	getVotes()
Long	getWatches()
Long	getWorkflowId()
boolean	isArchived() Returns true if issue is archived
boolean	isCreated()
boolean	isSubTask()
void	store() Persist this object's immediate fields.
String	toString()

Methods inherited from class com.atlassian.jira.issue.AbstractIssue

equals, getAttachments, getParent, getParentObject, hashCode, isEditable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentIssueImpl

public DocumentIssueImpl(org.apache.lucene.document.Document document,
                         ConstantsManager constantsManager,
                         FieldManager fieldManager,
                         IssueManager issueManager,
                         IssueFactory issueFactory,
                         AttachmentManager attachmentManager,
                         ProjectFactory projectFactory,
                         JqlLocalDateSupport jqlLocalDateSupport)

Method Detail

getId

public Long getId()

Returns:

the unique id of the entity.

getNumber

public Long getNumber()

getProject

public org.ofbiz.core.entity.GenericValue getProject()

getProjectObject

public Project getProjectObject()

Description copied from interface: Issue

Gets the Project for this Issue.

Returns:

The Project for this Issue.

getProjectId

public Long getProjectId()

Description copied from interface: Issue

Gets the ID of the Project for this Issue.

Returns:

The ID of the Project for this Issue.

getIssueTypeObject

public IssueType getIssueTypeObject()

Description copied from interface: Issue

Gets the IssueType for this Issue.

Specified by:

getIssueTypeObject in interface IssueContext

Specified by:

getIssueTypeObject in interface Issue

Overrides:

getIssueTypeObject in class AbstractIssue

Returns:

The IssueType for this Issue.

getIssueType

public IssueType getIssueType()

Description copied from interface: Issue

Gets the IssueType for this Issue.

Returns:

The IssueType for this Issue.

getIssueTypeId

public String getIssueTypeId()

Description copied from interface: Issue

Gets the ID of the IssueType for this Issue.

Returns:

The ID of the IssueType for this Issue.

getSummary

public String getSummary()

getAssigneeUser

public ApplicationUser getAssigneeUser()

Description copied from interface: Issue

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 Issue.getAssignee()

Returns:

the Assignee User.

See Also:

Issue.getAssignee()

getAssignee

public ApplicationUser getAssignee()

Description copied from interface: Issue

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

public String getAssigneeId()

Returns:

a user key of the assignee

getComponents

public Collection<ProjectComponent> getComponents()

Returns:

collection of project components (as objects) that this issue is assigned to

getComponentObjects

public Collection<ProjectComponent> getComponentObjects()

Deprecated. since 7.0, use getComponents() instead

Returns:

getLabels

public Set<Label> getLabels()

Description copied from interface: Issue

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

public boolean isArchived()

Description copied from interface: Issue

Returns true if issue is archived

Returns:

is issue archived

getArchivedByUser

public ApplicationUser getArchivedByUser()

Description copied from interface: Issue

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

public String getArchivedById()

Description copied from interface: Issue

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

public Timestamp getArchivedDate()

Description copied from interface: Issue

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.

getReporterUser

public ApplicationUser getReporterUser()

Description copied from interface: Issue

Returns the Reporter User.

This will return a non-null User object even if the User has been deleted.

Legacy synonym for Issue.getReporter().

Returns:

the Reporter User.

See Also:

Issue.getReporter()

getReporter

public ApplicationUser getReporter()

Description copied from interface: Issue

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

public String getReporterId()

Returns:

a user key of the reporter

getCreator

public ApplicationUser getCreator()

getCreatorId

public String getCreatorId()

Returns:

a user key of the creator

getDescription

public String getDescription()

getEnvironment

public String getEnvironment()

getAffectedVersions

public Collection<Version> getAffectedVersions()

Returns:

a collection of 'affects' Version objects.

getFixVersions

public Collection<Version> getFixVersions()

Returns:

a collection of fix-for Version objects.

getDueDate

public Timestamp getDueDate()

getSecurityLevel

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

Description copied from interface: Issue

Returns the Security Level for this Issue.

Returns:

the Security Level for this Issue.

getSecurityLevelId

public Long getSecurityLevelId()

Description copied from interface: Issue

Returns the Security Level for this Issue.

Returns:

the Security Level for this Issue.

getPriorityObject

public Priority getPriorityObject()

Description copied from interface: Issue

Returns the Priority for this Issue.

Specified by:

getPriorityObject in interface Issue

Overrides:

getPriorityObject in class AbstractIssue

Returns:

the Priority for this Issue.

getPriority

public Priority getPriority()

Description copied from interface: Issue

Returns the Priority for this Issue.

Returns:

the Priority for this Issue.

getResolutionId

public String getResolutionId()

getResolutionObject

public Resolution getResolutionObject()

Description copied from interface: Issue

Returns the Resolution for this Issue.

Specified by:

getResolutionObject in interface Issue

Overrides:

getResolutionObject in class AbstractIssue

Returns:

the Resolution for this Issue.

getResolution

public Resolution getResolution()

Description copied from interface: Issue

Returns the Resolution for this Issue.

Returns:

the Resolution for this Issue.

getKey

public String getKey()

Returns:

the entity key.

getVotes

public Long getVotes()

getWatches

public Long getWatches()

getCreated

public Timestamp getCreated()

getResolutionDate

public Timestamp getResolutionDate()

Description copied from interface: Issue

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

getUpdated

public Timestamp getUpdated()

getWorkflowId

public Long getWorkflowId()

getCustomFieldValue

public Object getCustomFieldValue(CustomField customField)

Parameters:

customField - the CustomField

Returns:

A custom field's value. Will be a List, User, Timestamp etc, depending on custom field type.

getStatusId

public String getStatusId()

getStatusObject

public Status getStatusObject()

Specified by:

getStatusObject in interface Issue

Overrides:

getStatusObject in class AbstractIssue

getStatus

public Status getStatus()

getOriginalEstimate

public Long getOriginalEstimate()

Description copied from interface: Issue

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

public Long getEstimate()

Description copied from interface: Issue

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

public Long getTimeSpent()

Description copied from interface: Issue

This is the "total time spent" working on this issue, in seconds.

Returns:

the "total time spent" working on this issue, in seconds.

getExternalFieldValue

public Object getExternalFieldValue(String fieldId)

isSubTask

public boolean isSubTask()

getParentId

public Long getParentId()

isCreated

public boolean isCreated()

getSubTasks

public Collection getSubTasks()

getSubTaskObjects

public Collection getSubTaskObjects()

Description copied from interface: Issue

Gets all the issue's subtasks.

Returns:

A collection of MutableIssues

getIssueRenderContext

public IssueRenderContext getIssueRenderContext()

getString

public String getString(String name)

Description copied from interface: OfBizValueWrapper

Retrieve a String field.

Parameters:

name - the field name

Returns:

the value for the given field.

getTimestamp

public Timestamp getTimestamp(String name)

Description copied from interface: OfBizValueWrapper

Retrieve a timestamp field.

Parameters:

name - the field name

Returns:

the value for the given field.

getLong

public Long getLong(String name)

Description copied from interface: OfBizValueWrapper

Retrieve a numeric field.

Parameters:

name - the field name

Returns:

the value for the given field.

getGenericValue

public org.ofbiz.core.entity.GenericValue getGenericValue()

Description copied from interface: Issue

Get the backing GenericValue object.

Returns:

the backing GenericValue object.

store

public void store()

Description copied from interface: OfBizValueWrapper

Persist this object's immediate fields.

As of JIRA 7.0 this method is considered optional. If this object is actually immutable, then it will throw UnsupportedOperationException because there are no possible mutations to store.

toString

public String toString()

Overrides:

toString in class Object