java.lang.Object | |||||
↳ | com.atlassian.jira.issue.fields.AbstractField | ||||
↳ | com.atlassian.jira.issue.fields.AbstractOrderableField<V> | ||||
↳ | com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl<V> | ||||
↳ | com.atlassian.jira.issue.fields.AbstractTextSystemField | ||||
↳ | com.atlassian.jira.issue.fields.SummarySystemField |
Copyright (c) 2002-2004 All rights reserved.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface com.atlassian.jira.issue.fields.NavigableField | |||||||||||
From interface
com.atlassian.jira.issue.fields.OrderableField
|
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.atlassian.jira.issue.fields.AbstractField
| |||||||||||
From interface
com.atlassian.jira.issue.fields.SummaryField
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Determines whether the field is available for bulk editing given the BulkEditBean.
| |||||||||||
Returns
true if a call to removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value. | |||||||||||
The order in which to sort the field when it is sorted for the first time.
| |||||||||||
The value that should be set on the issue if the field is not shown for some reason.
| |||||||||||
Return The default data for this system field.
| |||||||||||
Return a list of Lucene SortFields to be used for sorting search results.
| |||||||||||
A sorter to be used when sorting columns in a table.
| |||||||||||
Gets the value stored for this field on the provided issue.
| |||||||||||
Defines if a field determines itself as renderable.
| |||||||||||
Tests field specific way to determine if it should be shown or not.
| |||||||||||
Removes the field value from the given MutableIssue object.
| |||||||||||
Record the value on the issue (not saving it to the database, see updateValue).
| |||||||||||
validate the field value
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.atlassian.jira.issue.fields.AbstractTextSystemField
| |||||||||||
From class com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl | |||||||||||
From class
com.atlassian.jira.issue.fields.AbstractOrderableField
| |||||||||||
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.OrderableField
| |||||||||||
From interface
com.atlassian.jira.issue.fields.SearchableField
| |||||||||||
From interface
com.atlassian.jira.issue.fields.renderer.RenderableField
| |||||||||||
From interface
com.atlassian.jira.issue.fields.rest.RestAwareField
| |||||||||||
From interface
com.atlassian.jira.issue.fields.rest.RestFieldOperations
| |||||||||||
From interface
java.lang.Comparable
|
Determines whether the field is available for bulk editing given the BulkEditBean.
bulkEditBean | holds the state of the bulk-edit wizard (e.g. the selected issues for bulk editing) |
---|
null
if the field is available for bulk-editing or an i18n key of the error message to show as
why the field is not available.
Returns true
if a call to removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.
There a few different reasons why this method may return false:
issue | The Issue object. |
---|
true
if a call to removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.The order in which to sort the field when it is sorted for the first time.
ORDER_ASCENDING
or ORDER_DESCENDING
The value that should be set on the issue if the field is not shown for some reason.
For example: The user does not have permission to see the field, or the field is not part of the create screen.
issue | the Issue. |
---|
Return The default data for this system field. May be null if there is no default.
issueCtx | Issue (This should really only need to be an issue context, but for historical reasons we need an issue object. |
---|
Return a list of Lucene SortFields to be used for sorting search results.
Using this method allows the field to specify the most performant way to perform a search. If a field can be sorted directly using the term in the index then this should just return a singleton list with the sort field.
return Collections.singletonList(new SortField(fieldName, sortOrder));
The default implementation builds this using the FieldComparatorSource returned by getSortComparatorSource()
If you implement this method there is no need to implement getSortComparatorSource()
.
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.
getSortComparatorSource()
Gets the value stored for this field on the provided issue.
issue | identifies the issue that will contain the value for this field. |
---|
Defines if a field determines itself as renderable. This is needed because of the way that customfields are implemented. Since all the real work is done in CustomFieldTypes, if we want to treat system fields and custom fields the same way in the renderers then all custom fields must implement this interface. We therefore provide this method so that the CustomFieldImpl can delegate to the CustomFieldTypes to determine if a given custom field is renderable.
Tests field specific way to determine if it should be shown or not.
issue | The Issue. |
---|
Removes the field value from the given MutableIssue object.
Note that this operation does not actually persist the change, it just clears the value from the given Issue object. The caller will still need to call #updateValue() in order to persist the change.
Some Fields may choose to quietly ignore this request. eg The SecurityLevel Field will not remove Security Level from subtasks because the subtask must always take the Security Level of its parent issue.
issue | The issue object to be effected. |
---|
Record the value on the issue (not saving it to the database, see updateValue).
fieldLayoutItem | FieldLayoutItem |
---|---|
issue | MutableIssue |
fieldValueHolder | Field Value Holder Map |
validate the field value
operationContext | OperationContext |
---|---|
errorCollectionToAddTo | ErrorCollection |
i18n | I18nHelper |
issue | Issue |
fieldScreenRenderLayoutItem | FieldScreenRenderLayoutItem |