|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.mail.TemplateIssue
public class TemplateIssue
Decorator for the Issue Object.
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 theTemplateContext
for the velocity email templates
Constructor Summary | |
---|---|
TemplateIssue(Issue issue,
FieldLayoutManager fieldLayoutManager,
RendererManager rendererManager,
CustomFieldManager customFieldManager,
JiraDurationUtils jiraDurationUtils,
AggregateTimeTrackingCalculatorFactory aggregateTimeTrackingCalculatorFactory)
|
Method Summary | |
---|---|
Collection<Version> |
getAffectedVersions()
|
Long |
getAggregateOriginalEstimate()
|
Long |
getAggregateRemainingEstimate()
|
Long |
getAggregateTimeSpent()
|
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<Attachment> |
getAttachments()
|
Collection<ProjectComponent> |
getComponentObjects()
|
Collection<org.ofbiz.core.entity.GenericValue> |
getComponents()
|
Timestamp |
getCreated()
|
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()
|
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. |
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 |
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. |
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()
Return the reporter - an object will be returned even if the user has been deleted from the system. |
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<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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TemplateIssue(Issue issue, FieldLayoutManager fieldLayoutManager, RendererManager rendererManager, CustomFieldManager customFieldManager, JiraDurationUtils jiraDurationUtils, AggregateTimeTrackingCalculatorFactory aggregateTimeTrackingCalculatorFactory)
Method Detail |
---|
public Long getId()
getId
in interface Issue
public org.ofbiz.core.entity.GenericValue getProject()
IssueContext
A null return value is used to represent that this context applies to all Projects.
getProject
in interface IssueContext
getProject
in interface Issue
public Project getProjectObject()
Issue
getProjectObject
in interface IssueContext
getProjectObject
in interface Issue
public org.ofbiz.core.entity.GenericValue getIssueType()
Issue
getIssueType
in interface IssueContext
getIssueType
in interface Issue
public IssueType getIssueTypeObject()
Issue
getIssueTypeObject
in interface IssueContext
getIssueTypeObject
in interface Issue
public String getSummary()
getSummary
in interface Issue
public com.atlassian.crowd.embedded.api.User getAssignee()
Issue
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 com.atlassian.crowd.embedded.api.User getAssigneeUser()
Issue
Issue.getAssignee()
getAssigneeUser
in interface Issue
Issue.getAssignee()
public Collection<org.ofbiz.core.entity.GenericValue> getComponents()
getComponents
in interface Issue
public Collection<ProjectComponent> getComponentObjects()
getComponentObjects
in interface Issue
public com.atlassian.crowd.embedded.api.User getReporter()
Issue
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 com.atlassian.crowd.embedded.api.User getReporterUser()
getReporterUser
in interface Issue
Issue.getReporter()
public String getDescription()
getDescription
in interface Issue
public String getHtmlDescription()
public String getEnvironment()
getEnvironment
in interface Issue
public String getHtmlEnvironment()
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()
getSecurityLevel
in interface Issue
public Long getSecurityLevelId()
getSecurityLevelId
in interface Issue
public org.ofbiz.core.entity.GenericValue getPriority()
getPriority
in interface Issue
public Priority getPriorityObject()
getPriorityObject
in interface Issue
public String getResolutionId()
getResolutionId
in interface Issue
public org.ofbiz.core.entity.GenericValue getResolution()
getResolution
in interface Issue
public Resolution getResolutionObject()
getResolutionObject
in interface Issue
public String getKey()
getKey
in interface Issue
public Long getVotes()
getVotes
in interface Issue
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 CustomField
public CustomField getCustomField(String id)
public Object getCustomFieldValue(String id)
id
- Custom field key (eg. 'customfield_10010').
public org.ofbiz.core.entity.GenericValue getStatus()
getStatus
in interface Issue
public Status getStatusObject()
getStatusObject
in interface Issue
public Long getOriginalEstimate()
Issue
getOriginalEstimate
in interface Issue
public Long getEstimate()
Issue
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 boolean isSubTask()
isSubTask
in interface Issue
public Long getParentId()
getParentId
in interface Issue
public boolean isCreated()
isCreated
in interface Issue
public Issue getParentObject()
Issue
getParentObject
in interface Issue
public org.ofbiz.core.entity.GenericValue getParent()
getParent
in interface Issue
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 name
public Timestamp getTimestamp(String name)
OfBizValueWrapper
getTimestamp
in interface OfBizValueWrapper
name
- the field name
public Set<Label> getLabels()
Issue
getLabels
in interface Issue
public Long getLong(String name)
OfBizValueWrapper
getLong
in interface OfBizValueWrapper
name
- the field name
public org.ofbiz.core.entity.GenericValue getGenericValue()
OfBizValueWrapper
getGenericValue
in interface OfBizValueWrapper
public void store()
OfBizValueWrapper
store
in interface OfBizValueWrapper
public String getNiceTimeOriginalEstimate(I18nHelper i18n)
i18n
- helper bean for internationalization
public String getNiceTimeEstimate(I18nHelper i18n)
i18n
- helper bean for internationalization
public String getNiceTimeSpent(I18nHelper i18n)
i18n
- helper bean for internationalization
public boolean isAnyAggregateDifferent()
public String getNiceTimeAggregateOriginalEstimate(I18nHelper i18n)
i18n
- helper bean for internationalization
public String getNiceTimeAggregateRemainingEstimate(I18nHelper i18n)
i18n
- helper bean for internationalization
public String getNiceTimeAggregateTimeSpent(I18nHelper i18n)
i18n
- helper bean for internationalization
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |