com.atlassian.jira.issue
Class DocumentIssueImpl

java.lang.Object
  extended by com.atlassian.jira.issue.AbstractIssue
      extended by com.atlassian.jira.issue.DocumentIssueImpl
All Implemented Interfaces:
IssueContext, Issue, OfBizValueWrapper

public class DocumentIssueImpl
extends AbstractIssue


Field Summary
 
Fields inherited from class com.atlassian.jira.issue.AbstractIssue
attachmentManager, constantsManager, issueManager
 
Constructor Summary
DocumentIssueImpl(org.apache.lucene.document.Document document, ConstantsManager constantsManager, FieldManager fieldManager, IssueManager issueManager, IssueFactory issueFactory, AttachmentManager attachmentManager, ProjectFactory projectFactory, JqlLocalDateSupport jqlLocalDateSupport)
           
 
Method Summary
 boolean equals(Object o)
           
 Collection<Version> getAffectedVersions()
           
 com.atlassian.crowd.embedded.api.User getAssignee()
          Returns the Assignee User.
 String getAssigneeId()
           
 com.atlassian.crowd.embedded.api.User getAssigneeUser()
          Returns the Assignee User.
 Collection<ProjectComponent> getComponentObjects()
           
 Collection<org.ofbiz.core.entity.GenericValue> getComponents()
           
 Timestamp getCreated()
           
 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 milliseconds.
 Object getExternalFieldValue(String fieldId)
           
 Collection<Version> getFixVersions()
           
 org.ofbiz.core.entity.GenericValue getGenericValue()
          Get the backing GenericValue object.
 Long getId()
           
 IssueRenderContext getIssueRenderContext()
           
 org.ofbiz.core.entity.GenericValue getIssueType()
          Gets 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 getOriginalEstimate()
          This is the "original estimate" of work to be performed on this issue, in milliseconds.
 Long getParentId()
           
 org.ofbiz.core.entity.GenericValue getPriority()
           
 Priority getPriorityObject()
           
 org.ofbiz.core.entity.GenericValue getProject()
          Gets the Project for this IssueContext.
 Project getProjectObject()
          Gets the Project for this Issue.
 com.atlassian.crowd.embedded.api.User getReporter()
          Returns the Reporter User.
 String getReporterId()
           
 com.atlassian.crowd.embedded.api.User getReporterUser()
          Returns the Reporter User.
 org.ofbiz.core.entity.GenericValue getResolution()
           
 Timestamp getResolutionDate()
          Returns the datetime that an issue was resolved on.
 String getResolutionId()
           
 Resolution getResolutionObject()
           
 org.ofbiz.core.entity.GenericValue getSecurityLevel()
           
 Long getSecurityLevelId()
           
 org.ofbiz.core.entity.GenericValue getStatus()
           
 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 milliseconds.
 Timestamp getTimestamp(String name)
          Retrieve a timestamp field.
 Timestamp getUpdated()
           
 Long getVotes()
           
 Long getWatches()
           
 Long getWorkflowId()
           
 int hashCode()
           
 boolean isCreated()
           
 boolean isSubTask()
           
 void store()
          Persist this object's immediate fields.
 
Methods inherited from class com.atlassian.jira.issue.AbstractIssue
getAttachments, getParent, getParentObject, isEditable
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, 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()

getProject

public org.ofbiz.core.entity.GenericValue getProject()
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.

Returns:
The Project for this IssueContext (can be null).

getProjectObject

public Project getProjectObject()
Description copied from interface: Issue
Gets the Project for this Issue.

Returns:
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 org.ofbiz.core.entity.GenericValue getIssueType()
Description copied from interface: Issue
Gets the IssueType for this Issue.

Returns:
The IssueType for this Issue.

getSummary

public String getSummary()

getAssigneeUser

public com.atlassian.crowd.embedded.api.User 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 com.atlassian.crowd.embedded.api.User 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()

getComponents

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

getComponentObjects

public Collection<ProjectComponent> getComponentObjects()
Returns:
collection of project components (as objects) that this issue is assigned to

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

getReporterUser

public com.atlassian.crowd.embedded.api.User 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 com.atlassian.crowd.embedded.api.User 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()

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()

getSecurityLevelId

public Long getSecurityLevelId()

getPriorityObject

public Priority getPriorityObject()
Specified by:
getPriorityObject in interface Issue
Overrides:
getPriorityObject in class AbstractIssue

getPriority

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

getResolutionId

public String getResolutionId()

getResolutionObject

public Resolution getResolutionObject()
Specified by:
getResolutionObject in interface Issue
Overrides:
getResolutionObject in class AbstractIssue

getResolution

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

getKey

public String getKey()

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.

getStatusObject

public Status getStatusObject()
Specified by:
getStatusObject in interface Issue
Overrides:
getStatusObject in class AbstractIssue

getStatus

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

getOriginalEstimate

public Long getOriginalEstimate()
Description copied from interface: Issue
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

public Long getEstimate()
Description copied from interface: Issue
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

public Long getTimeSpent()
Description copied from interface: Issue
This is the "total time spent" working on this issue, in milliseconds.

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

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: OfBizValueWrapper
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.


equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2002-2012 Atlassian. All Rights Reserved.