public class

WorkRatioSystemField

extends NavigableFieldImpl
implements SearchableField RestAwareField
java.lang.Object
   ↳ com.atlassian.jira.issue.fields.AbstractField
     ↳ com.atlassian.jira.issue.fields.NavigableFieldImpl
       ↳ com.atlassian.jira.issue.fields.WorkRatioSystemField

Summary

[Expand]
Inherited Constants
From interface com.atlassian.jira.issue.fields.NavigableField
[Expand]
Inherited Fields
From class com.atlassian.jira.issue.fields.NavigableFieldImpl
From class com.atlassian.jira.issue.fields.AbstractField
Public Constructors
WorkRatioSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, WorkRatioSearchHandlerFactory handlerFactory)
Public Methods
SearchHandler createAssociatedSearchHandler()
Return SearchHandler for the field.
String getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
Returns lower level Information about the field.
FieldJsonRepresentation getJsonFromIssue(Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem)
Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.
JsonType getJsonSchema()
Return a description of the shape of this field when represented as JSON.
LuceneFieldSorter getSorter()
long getWorkRatio(Issue issue)
[Expand]
Inherited Methods
From class com.atlassian.jira.issue.fields.NavigableFieldImpl
From class com.atlassian.jira.issue.fields.AbstractField
From class java.lang.Object
From interface com.atlassian.jira.issue.fields.Field
From interface com.atlassian.jira.issue.fields.NavigableField
From interface com.atlassian.jira.issue.fields.SearchableField
From interface com.atlassian.jira.issue.fields.rest.RestAwareField
From interface java.lang.Comparable

Public Constructors

public WorkRatioSystemField (VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, WorkRatioSearchHandlerFactory handlerFactory)

Public Methods

public SearchHandler createAssociatedSearchHandler ()

Return SearchHandler for the field. This object tells JIRA how to search for values within the field.

Returns
  • the SearchHandler associated with the field. Can return null when no searcher is associated with the field. This will mainly happen when a customfield is configured to have no searcher.

public String getColumnViewHtml (FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)

public FieldTypeInfo getFieldTypeInfo (FieldTypeInfoContext fieldTypeInfoContext)

Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url

Parameters
fieldTypeInfoContext the FieldTypeInfoContext contains context information that is relevant to generate the FieldTypeInfo

public FieldJsonRepresentation getJsonFromIssue (Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem)

Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

Parameters
issue to get field data from
renderedVersionRequested whether the use requested the return of rendered/pretty data as well as raw data
fieldLayoutItem field layout for this field. Will only be supplied if the field is also an ordereable field.
Returns
  • FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

public JsonType getJsonSchema ()

Return a description of the shape of this field when represented as JSON.

public LuceneFieldSorter getSorter ()

public long getWorkRatio (Issue issue)