com.atlassian.jira.issue.fields

Class WorkRatioSystemField

java.lang.Object

com.atlassian.jira.issue.fields.AbstractField

com.atlassian.jira.issue.fields.NavigableFieldImpl

com.atlassian.jira.issue.fields.WorkRatioSystemField

All Implemented Interfaces:

Field, NavigableField, RestAwareField, SearchableField, Comparable

public class WorkRatioSystemField
extends NavigableFieldImpl
implements SearchableField, RestAwareField

Field Summary

Fields inherited from class com.atlassian.jira.issue.fields.NavigableFieldImpl

applicationProperties, templatingEngine

Fields inherited from class com.atlassian.jira.issue.fields.AbstractField

authenticationContext

Fields inherited from interface com.atlassian.jira.issue.fields.NavigableField

ORDER_ASCENDING, ORDER_DESCENDING, TEMPLATE_DIRECTORY_PATH

Constructor Summary

Constructors

Constructor and Description
WorkRatioSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, WorkRatioSearchHandlerFactory handlerFactory)

Method Summary

Methods

Modifier and Type	Method and Description
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() A sorter to be used when sorting columns in a table.
long	getWorkRatio(Issue issue)

Methods inherited from class com.atlassian.jira.issue.fields.NavigableFieldImpl

getApplicationProperties, getColumnCssClass, getColumnHeadingKey, getDefaultSortOrder, getHiddenFieldId, getSortComparatorSource, getSortFields, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory, renderTemplate

Methods inherited from class com.atlassian.jira.issue.fields.AbstractField

compareTo, equals, getAuthenticationContext, getId, getName, getNameKey, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.fields.Field

getId, getName, getNameKey

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

WorkRatioSystemField

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

Method Detail

getSorter

public LuceneFieldSorter getSorter()

Description copied from interface: NavigableField

A sorter to be used when sorting columns in a table. This sort uses the Lucene Document Collection and is therefore a lot faster than sorting the issues in memory.

Specified by:

getSorter in interface NavigableField

Returns:

A sorter that can be used to sort this field, or null depending on the value of NavigableField.getSortComparatorSource()

See Also:

DocumentIssueImpl, MappedSortComparator

getColumnViewHtml

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

Specified by:

getColumnViewHtml in interface NavigableField

getWorkRatio

public long getWorkRatio(Issue issue)

createAssociatedSearchHandler

public SearchHandler createAssociatedSearchHandler()

Description copied from interface: SearchableField

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

Specified by:

createAssociatedSearchHandler in interface SearchableField

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.

getFieldTypeInfo

public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)

Description copied from interface: RestAwareField

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

Specified by:

getFieldTypeInfo in interface RestAwareField

Parameters:

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

getJsonSchema

public JsonType getJsonSchema()

Description copied from interface: RestAwareField

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

Specified by:

getJsonSchema in interface RestAwareField

getJsonFromIssue

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

Description copied from interface: RestAwareField

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.

Specified by:

getJsonFromIssue in interface RestAwareField

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.