public class TemplateIssue extends Object implements Issue
This class will ensure backwards compatibility for templates accessing the issue object. This class also includes helper methods for retrieving rendered fields (e.g. description, environment) and nicely formatted date fields (e.g. Original Time Estimate, Time Spent, etc.).
This object is passed to the template through the TemplateContext
for the velocity email templates
GLOBAL
ID_COMPARATOR
Constructor and Description |
---|
TemplateIssue(Issue issue,
FieldLayoutManager fieldLayoutManager,
RendererManager rendererManager,
CustomFieldManager customFieldManager,
JiraDurationUtils jiraDurationUtils,
AggregateTimeTrackingCalculatorFactory aggregateTimeTrackingCalculatorFactory) |
Modifier and Type | Method and Description |
---|---|
Collection<Version> |
getAffectedVersions() |
Long |
getAggregateOriginalEstimate() |
Long |
getAggregateRemainingEstimate() |
Long |
getAggregateTimeSpent() |
ApplicationUser |
getAssignee()
Returns the Assignee User.
|
String |
getAssigneeId() |
ApplicationUser |
getAssigneeUser()
Returns the Assignee User.
|
Collection<Attachment> |
getAttachments() |
Collection<ProjectComponent> |
getComponentObjects()
Deprecated.
Use
getComponents() . Since v7.0 |
Collection<ProjectComponent> |
getComponents() |
Timestamp |
getCreated() |
ApplicationUser |
getCreator() |
String |
getCreatorId() |
CustomField |
getCustomField(String id) |
Object |
getCustomFieldValue(CustomField customField) |
Object |
getCustomFieldValue(String id)
Get value for a custom field.
|
String |
getDescription()
Retrieve the description of the issue.
|
Timestamp |
getDueDate() |
String |
getEnvironment()
Retrieve the environment of the issue.
|
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.
|
String |
getHtmlDescription()
Retrieves the html formatted description.
|
String |
getHtmlEnvironment()
Retrieves the html formatted environment.
|
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.
|
String |
getNiceTimeAggregateOriginalEstimate(I18nHelper i18n)
Return a formatted time string of the aggregate original time estimate.
|
String |
getNiceTimeAggregateRemainingEstimate(I18nHelper i18n)
Return a formatted time string of the aggregate time estimate.
|
String |
getNiceTimeAggregateTimeSpent(I18nHelper i18n)
Return a formatted time string of the aggregate time spent.
|
String |
getNiceTimeEstimate(I18nHelper i18n)
Return a formatted time string of the time estimate.
|
String |
getNiceTimeOriginalEstimate(I18nHelper i18n)
Return a formatted time string of the original time estimate.
|
String |
getNiceTimeSpent(I18nHelper i18n)
Return a formatted time string of the time spent.
|
Long |
getNumber() |
Long |
getOriginalEstimate()
This is the "original estimate" of work to be performed on this issue, in milliseconds.
|
org.ofbiz.core.entity.GenericValue |
getParent() |
Long |
getParentId() |
Issue |
getParentObject()
If this issue is a subtask, return its parent.
|
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()
Return the reporter - an object will be returned even if the user has been deleted from the system.
|
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<Issue> |
getSubTaskObjects()
Gets all the issue's subtasks.
|
Collection<org.ofbiz.core.entity.GenericValue> |
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() |
boolean |
isAnyAggregateDifferent()
Are any of the aggregates different?
|
boolean |
isCreated() |
boolean |
isEditable() |
boolean |
isSubTask() |
void |
store()
Persist this object's immediate fields.
|
String |
toString() |
public TemplateIssue(Issue issue, FieldLayoutManager fieldLayoutManager, RendererManager rendererManager, CustomFieldManager customFieldManager, JiraDurationUtils jiraDurationUtils, AggregateTimeTrackingCalculatorFactory aggregateTimeTrackingCalculatorFactory)
public Long getId()
public org.ofbiz.core.entity.GenericValue getProject()
getProject
in interface Issue
public Project getProjectObject()
Issue
getProjectObject
in interface IssueContext
getProjectObject
in interface Issue
public Long getProjectId()
Issue
getProjectId
in interface IssueContext
getProjectId
in interface Issue
public IssueType getIssueType()
Issue
getIssueType
in interface IssueContext
getIssueType
in interface Issue
public IssueType getIssueTypeObject()
Issue
getIssueTypeObject
in interface IssueContext
getIssueTypeObject
in interface Issue
public String getIssueTypeId()
Issue
getIssueTypeId
in interface IssueContext
getIssueTypeId
in interface Issue
public String getSummary()
getSummary
in interface Issue
public ApplicationUser getAssignee()
Issue
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.
getAssignee
in interface Issue
public String getAssigneeId()
getAssigneeId
in interface Issue
public ApplicationUser getAssigneeUser()
Issue
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()
getAssigneeUser
in interface Issue
Issue.getAssignee()
public Collection<ProjectComponent> getComponentObjects()
getComponents()
. Since v7.0getComponentObjects
in interface Issue
public Collection<ProjectComponent> getComponents()
getComponents
in interface Issue
public ApplicationUser getReporter()
Issue
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.
getReporter
in interface Issue
public String getReporterId()
getReporterId
in interface Issue
public ApplicationUser getCreator()
getCreator
in interface Issue
public String getCreatorId()
getCreatorId
in interface Issue
public ApplicationUser getReporterUser()
getReporterUser
in interface Issue
Issue.getReporter()
public String getDescription()
getDescription
in interface Issue
public String getHtmlDescription()
A simple string (with linked bug keys displayed) is returned if a rendered version cannot be generated.
public String getEnvironment()
getEnvironment
in interface Issue
public String getHtmlEnvironment()
A simple string (with linked bug keys displayed) is returned if a rendered version cannot be generated.
public Collection<Version> getAffectedVersions()
getAffectedVersions
in interface Issue
Version
objects.public Collection<Version> getFixVersions()
getFixVersions
in interface Issue
Version
objects.public Timestamp getDueDate()
getDueDate
in interface Issue
public org.ofbiz.core.entity.GenericValue getSecurityLevel()
Issue
getSecurityLevel
in interface Issue
public Long getSecurityLevelId()
Issue
getSecurityLevelId
in interface Issue
public Priority getPriority()
Issue
getPriority
in interface Issue
public Priority getPriorityObject()
Issue
getPriorityObject
in interface Issue
public String getResolutionId()
getResolutionId
in interface Issue
public Resolution getResolution()
Issue
getResolution
in interface Issue
public Resolution getResolutionObject()
Issue
getResolutionObject
in interface Issue
public String getKey()
public Long getWatches()
getWatches
in interface Issue
public Timestamp getCreated()
getCreated
in interface Issue
public Timestamp getResolutionDate()
Issue
getResolutionDate
in interface Issue
public Timestamp getUpdated()
getUpdated
in interface Issue
public Long getWorkflowId()
getWorkflowId
in interface Issue
public Object getCustomFieldValue(CustomField customField)
getCustomFieldValue
in interface Issue
customField
- the CustomFieldpublic CustomField getCustomField(String id)
public Object getCustomFieldValue(String id)
id
- Custom field key (eg. 'customfield_10010').public String getStatusId()
getStatusId
in interface Issue
public Status getStatusObject()
getStatusObject
in interface Issue
public Long getOriginalEstimate()
Issue
getOriginalEstimate
in interface Issue
public Long getEstimate()
Issue
A better name would be getRemainingEstimate but for historical reasons it is called what it is called.
getEstimate
in interface Issue
public Long getTimeSpent()
Issue
getTimeSpent
in interface Issue
public Long getAggregateOriginalEstimate()
public Long getAggregateRemainingEstimate()
public Long getAggregateTimeSpent()
public Object getExternalFieldValue(String fieldId)
getExternalFieldValue
in interface Issue
public Long getParentId()
getParentId
in interface Issue
public Issue getParentObject()
Issue
getParentObject
in interface Issue
public org.ofbiz.core.entity.GenericValue getParent()
public Collection<org.ofbiz.core.entity.GenericValue> getSubTasks()
getSubTasks
in interface Issue
public Collection<Issue> getSubTaskObjects()
Issue
getSubTaskObjects
in interface Issue
MutableIssue
spublic boolean isEditable()
isEditable
in interface Issue
public IssueRenderContext getIssueRenderContext()
getIssueRenderContext
in interface Issue
public Collection<Attachment> getAttachments()
getAttachments
in interface Issue
Attachment
objectspublic String getString(String name)
OfBizValueWrapper
getString
in interface OfBizValueWrapper
name
- the field namepublic Timestamp getTimestamp(String name)
OfBizValueWrapper
getTimestamp
in interface OfBizValueWrapper
name
- the field namepublic Set<Label> getLabels()
Issue
public Long getLong(String name)
OfBizValueWrapper
getLong
in interface OfBizValueWrapper
name
- the field namepublic org.ofbiz.core.entity.GenericValue getGenericValue()
Issue
getGenericValue
in interface Issue
getGenericValue
in interface OfBizValueWrapper
public void store()
OfBizValueWrapper
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.
store
in interface OfBizValueWrapper
public String getNiceTimeOriginalEstimate(I18nHelper i18n)
i18n
- helper bean for internationalizationpublic String getNiceTimeEstimate(I18nHelper i18n)
i18n
- helper bean for internationalizationpublic String getNiceTimeSpent(I18nHelper i18n)
i18n
- helper bean for internationalizationpublic boolean isAnyAggregateDifferent()
public String getNiceTimeAggregateOriginalEstimate(I18nHelper i18n)
i18n
- helper bean for internationalizationpublic String getNiceTimeAggregateRemainingEstimate(I18nHelper i18n)
i18n
- helper bean for internationalizationpublic String getNiceTimeAggregateTimeSpent(I18nHelper i18n)
i18n
- helper bean for internationalizationCopyright © 2002-2015 Atlassian. All Rights Reserved.