Class IssueLinksSystemField
- All Implemented Interfaces:
ExportableSystemField
,Field
,HideableField
,NavigableField
,OrderableField<IssueLinksSystemField.IssueLinkingValue>
,RequirableField
,RestAwareField
,RestFieldOperations
,SearchableField
,Comparable
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
This interface is used as a value object for IssueLinking information. -
Field Summary
FieldsFields 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
Fields inherited from interface com.atlassian.jira.issue.fields.OrderableField
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH
-
Constructor Summary
ConstructorsConstructorDescriptionIssueLinksSystemField
(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, IssueLinkService issueLinkService, UserHistoryManager userHistoryManager, IssueLinkManager issueLinkManager, RemoteIssueLinkManager remoteIssueLinkManager, IssueLinksBeanBuilderFactory issueLinkBeanBuilderFactory, I18nHelper.BeanFactory i18nFactory, IssueLinkTypeFinder issueLinkTypeFinder, JiraBaseUrls jiraBaseUrls, IssueLinkTypesSearchHandlerFactory issueLinkTypesSearchHandlerFactory) -
Method Summary
Modifier and TypeMethodDescriptionavailableForBulkEdit
(BulkEditBean bulkEditBean) Determines whether the field is available for bulk editing given the BulkEditBean.boolean
Returnstrue
if a call toOrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.void
createValue
(Issue issue, IssueLinksSystemField.IssueLinkingValue value) Create the value of the issue in the data store.getBulkEditHtml
(OperationContext operationContext, webwork.action.Action action, BulkEditBean bulkEditBean, Map displayParameters) Returns HTML that should be shown when the issue is being bulk edited.getColumnViewHtml
(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue) getCreateHtml
(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Returns the HTML that should be shown when the issue is being created.The order in which to sort the field when it is sorted for the first time.getDefaultValue
(Issue issue) The value that should be set on the issue if the field is not shown for some reason.getEditHtml
(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Returns HTML that should be shown when the issue is being edited.getFieldTypeInfo
(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.Returns the id of the field to check for visibility.getJsonDefaultValue
(IssueContext issueCtx) Return The default data for this system field.getJsonFromIssue
(Issue issue, boolean renderedVersionRequired, 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.Return a description of the shape of this field when represented as JSON.protected Object
getRelevantParams
(Map<String, String[]> inputParameters) This is implemented in response to use being an AbstractOrderableField.getRepresentationFromIssue
(Issue issue) For the given issue get an exportable representation for the fieldorg.apache.lucene.search.FieldComparatorSource
A sortComparatorSource object to be used for sorting columns in a table.A sorter to be used when sorting columns in a table.List<org.apache.lucene.search.SortField>
getSortFields
(boolean sortOrder) Return a list of Lucene SortFields to be used for sorting search results.getValueFromParams
(Map fieldValueHolder) This is called from BulkEdit/BulkWorkflowTransition to get an value object from a input set of values.getViewHtml
(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, IssueLinksSystemField.IssueLinkingValue value, Map displayParameters) getViewHtml
(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters) boolean
Determines if the field has a value for the given issue.boolean
Tests field specific way to determine if it should be shown or not.needsMove
(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem) Used to determine if the field needs input from user to be moved to the new project and/or issue type.void
populateDefaults
(Map<String, Object> fieldValuesHolder, Issue issue) We don't return any default for the field.void
Used to populate the fieldValueHolder with parameters for move issue screen.void
populateFromIssue
(Map<String, Object> fieldValuesHolder, Issue issue) This is called to populate the field values holder with the current state of the Issue object.void
This was called by Jelly code to map a value into a field values holder.prettyPrintChangeHistory
(String changeHistory) prettyPrintChangeHistory
(String changeHistory, I18nHelper i18nHelper) Used for email notification templates - allows changelog to be displayed in language of the recipient.void
Removes the field value from the given MutableIssue object.void
updateIssue
(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder) This is called to back update the MutableIssue with the value object we previously stuffed into the field values holder.void
updateValue
(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder) This is called after the issue has been stored on disk and allows us a chance to create change records for the update.void
validateParams
(OperationContext operationContext, ErrorCollection errorCollection, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) Ensure that the parameters are validMethods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField
createAssociatedSearchHandler, getApplicationProperties, getCreateHtml, getEditHtml, getFieldLayoutItemForBulkOperation, getIssueForBulkOperation, getPermissionManager, getVelocityParams, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, validateBulkEditHtmlProperties, valuesEqual
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 java.lang.Comparable
compareTo
Methods inherited from interface com.atlassian.jira.issue.fields.Field
getId, getName, getNameKey
Methods inherited from interface com.atlassian.jira.issue.fields.NavigableField
prettyPrintChangeHistory
-
Field Details
-
PARAMS_ISCREATEISSUE
- See Also:
-
PARAMS_LINK_TYPE
- See Also:
-
PARAMS_ISSUE_KEYS
- See Also:
-
-
Constructor Details
-
IssueLinksSystemField
public IssueLinksSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, IssueLinkService issueLinkService, UserHistoryManager userHistoryManager, IssueLinkManager issueLinkManager, RemoteIssueLinkManager remoteIssueLinkManager, IssueLinksBeanBuilderFactory issueLinkBeanBuilderFactory, I18nHelper.BeanFactory i18nFactory, IssueLinkTypeFinder issueLinkTypeFinder, JiraBaseUrls jiraBaseUrls, IssueLinkTypesSearchHandlerFactory issueLinkTypesSearchHandlerFactory)
-
-
Method Details
-
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 interfaceNavigableField
- Returns:
- A sorter that can be used to sort this field, or null depending on the value of
NavigableField.getSortComparatorSource()
- See Also:
-
getSortFields
Description copied from interface:NavigableField
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
NavigableField.getSortComparatorSource()
If you implement this method there is no need to implement
NavigableField.getSortComparatorSource()
.- Specified by:
getSortFields
in interfaceNavigableField
- Returns:
- The name of the indexed term to be used for native Lucene sorting.
-
getColumnViewHtml
- Specified by:
getColumnViewHtml
in interfaceNavigableField
-
getCreateHtml
public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Description copied from interface:OrderableField
Returns the HTML that should be shown when the issue is being created.- Specified by:
getCreateHtml
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.- Returns:
- the HTML that should be shown when the issue is being created.
-
getEditHtml
public String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Description copied from interface:OrderableField
Returns HTML that should be shown when the issue is being edited.- Specified by:
getEditHtml
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.- Returns:
- HTML that should be shown when the issue is being edited.
-
getViewHtml
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters) - Specified by:
getViewHtml
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
-
getViewHtml
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, IssueLinksSystemField.IssueLinkingValue value, Map displayParameters) - Specified by:
getViewHtml
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
-
getBulkEditHtml
public String getBulkEditHtml(OperationContext operationContext, webwork.action.Action action, BulkEditBean bulkEditBean, Map displayParameters) Description copied from class:AbstractOrderableField
Returns HTML that should be shown when the issue is being bulk edited. By default calls theOrderableField.getEditHtml(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.customfields.OperationContext, webwork.action.Action, com.atlassian.jira.issue.Issue, java.util.Map)
method with null forFieldLayoutItem
and the first issue in the collection}- Specified by:
getBulkEditHtml
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Overrides:
getBulkEditHtml
in classAbstractOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
operationContext
- OperationContextaction
- ActionbulkEditBean
- BulkEditBeandisplayParameters
- Map of display parameters.- Returns:
- HTML that should be shown when the issue is being edited.
-
createValue
Description copied from interface:OrderableField
Create the value of the issue in the data store.- Specified by:
createValue
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
issue
- Issue this field is part ofvalue
- Value to store in this field (eg. Collection for Version fields). Cannot be null.
-
getDefaultValue
Description copied from interface:OrderableField
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.
- Specified by:
getDefaultValue
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
issue
- the Issue.- Returns:
- The default value. It can be null, or an empty collection.
-
populateDefaults
We don't return any default for the field.- Specified by:
populateDefaults
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The issue in play.
-
populateParamsFromString
public void populateParamsFromString(Map<String, Object> fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationExceptionThis was called by Jelly code to map a value into a field values holder.- Specified by:
populateParamsFromString
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
fieldValuesHolder
- Map of field Values.stringValue
- user friendly string value.issue
- the issue in play.- Throws:
FieldValidationException
- if cannot convert to a value from the given string
-
populateForMove
public void populateForMove(Map<String, Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue) Description copied from interface:OrderableField
Used to populate the fieldValueHolder with parameters for move issue screen. This field is only called if the issue needs to be updated during move, i.e.OrderableField.needsMove(java.util.Collection, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem)
returned true, and the remote user (the one performing the move) has the permission to actually update this field.- Specified by:
populateForMove
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
fieldValuesHolder
- Map of field Values.originalIssue
- orignal IssuetargetIssue
- target Issue
-
getRelevantParams
This is implemented in response to use being an AbstractOrderableField. It is actually called via populateFromParams so that we can place our relevant value object into the field values holder map. See above for the code entry point.- Specified by:
getRelevantParams
in classAbstractOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
inputParameters
- the input parameters.- Returns:
- the object to be placed into a field values holder map under our id.
-
populateFromIssue
This is called to populate the field values holder with the current state of the Issue object. For example this will be called when the issue is edited.- Specified by:
populateFromIssue
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The issue in play.
-
validateParams
public void validateParams(OperationContext operationContext, ErrorCollection errorCollection, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) Description copied from interface:OrderableField
Ensure that the parameters are valid- Specified by:
validateParams
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
operationContext
- OperationContexterrorCollection
- ErrorCollection to add to.i18n
- I18nHelperissue
- This is passed to get the value of other fields that may or may not have been modified.fieldScreenRenderLayoutItem
- FieldScreenRenderLayoutItem
-
getValueFromParams
This is called from BulkEdit/BulkWorkflowTransition to get an value object from a input set of values.- Specified by:
getValueFromParams
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
fieldValueHolder
- the map of parameters.- Returns:
- a parsed long or null if not in the input.
-
updateIssue
This is called to back update the MutableIssue with the value object we previously stuffed into the field values holder.This is called prior to the issue being stored on disk.
- Specified by:
updateIssue
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
fieldLayoutItem
- FieldLayoutItem in play.issue
- MutableIssue in play.fieldValueHolder
- Field Value Holder Map.- See Also:
-
updateValue
public void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder) This is called after the issue has been stored on disk and allows us a chance to create change records for the update.- Specified by:
updateValue
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
fieldLayoutItem
- for this field within this context.issue
- Issue this field is part of.modifiedValue
- new value to set field to. Cannot be null.issueChangeHolder
- an object to record any changes made to the issue by this method.
-
needsMove
public MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem) Description copied from interface:OrderableField
Used to determine if the field needs input from user to be moved to the new project and/or issue type. This method is called only if the field is visible in the target project/issue type.- Specified by:
needsMove
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
originalIssues
- Collection of original Issues.targetIssue
- Nonexistent issue object with values representing those of issue(s) after movetargetFieldLayoutItem
- FieldLayoutItem- Returns:
- A MessagedResult with result=true if the field needs input to be moved.
-
removeValueFromIssueObject
Description copied from interface:OrderableField
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.
- Specified by:
removeValueFromIssueObject
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
issue
- The issue object to be effected.- See Also:
-
isShown
Description copied from interface:OrderableField
Tests field specific way to determine if it should be shown or not.- Specified by:
isShown
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
issue
- The Issue.- Returns:
- true if it should be shown.
-
canRemoveValueFromIssueObject
Description copied from interface:OrderableField
Returnstrue
if a call toOrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.There a few different reasons why this method may return false:
- The OrderableField can sometimes remove the value, but it decides that it is not relevant for this Issue. eg: Security Level will ignore remove requests on a subtask, as the subtask Security is not set explicitly (it is always inherited from its parent issue).
- It may possible to remove this value, but the OrderableField does not actually do the job, it is done through some special mechanism. eg Attachments.
- This field is some special system field which it is invalid to remove. eg Project. In these cases calling removeValueFromIssueObject() would normally raise an UnsupportedOperationException.
- Specified by:
canRemoveValueFromIssueObject
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
issue
- The Issue object.- Returns:
true
if a call toOrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.- See Also:
-
hasValue
Description copied from interface:OrderableField
Determines if the field has a value for the given issue.- Specified by:
hasValue
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
issue
- the Issue.- Returns:
- true if the given Issue has a value for this field.
-
availableForBulkEdit
Description copied from interface:OrderableField
Determines whether the field is available for bulk editing given the BulkEditBean.- Specified by:
availableForBulkEdit
in interfaceOrderableField<IssueLinksSystemField.IssueLinkingValue>
- Parameters:
bulkEditBean
- holds the state of the bulk-edit wizard (e.g. the selected issues for bulk editing)- Returns:
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.
-
getColumnHeadingKey
- Specified by:
getColumnHeadingKey
in interfaceNavigableField
-
getColumnCssClass
- Specified by:
getColumnCssClass
in interfaceNavigableField
-
getDefaultSortOrder
Description copied from interface:NavigableField
The order in which to sort the field when it is sorted for the first time.- Specified by:
getDefaultSortOrder
in interfaceNavigableField
- Returns:
- Either
NavigableField.ORDER_ASCENDING
orNavigableField.ORDER_DESCENDING
-
getSortComparatorSource
public org.apache.lucene.search.FieldComparatorSource getSortComparatorSource()Description copied from interface:NavigableField
A sortComparatorSource object to be used for sorting columns in a table. In most cases this will use aMappedSortComparator
using theNavigableField.getSorter()
method. However, fields can provide any sorting mechanism that they wish.If a field can be sorted directly using terms in the Lucene index then the field should implement
NavigableField.getSortFields(boolean sortOrder)
rather than this method.In large installations custom sorting may incur a maor performance penalty.
- Specified by:
getSortComparatorSource
in interfaceNavigableField
- Returns:
- A SortComparatorSource that can be used to sort, or null if this field does not use custom sorting
-
getHiddenFieldId
Description copied from interface:NavigableField
Returns the id of the field to check for visibility. For example, with original estimate field need to ensure that the timetracking field is not hidden. With most fields, this is the same as their id.- Specified by:
getHiddenFieldId
in interfaceNavigableField
-
prettyPrintChangeHistory
- Specified by:
prettyPrintChangeHistory
in interfaceNavigableField
-
prettyPrintChangeHistory
Description copied from interface:NavigableField
Used for email notification templates - allows changelog to be displayed in language of the recipient.- Specified by:
prettyPrintChangeHistory
in interfaceNavigableField
- Parameters:
changeHistory
- - label- Returns:
- String change history formatted according to locale in i18nHelper
-
getFieldTypeInfo
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 interfaceRestAwareField
- Parameters:
fieldTypeInfoContext
- theFieldTypeInfoContext
contains context information that is relevant to generate theFieldTypeInfo
-
getJsonSchema
Description copied from interface:RestAwareField
Return a description of the shape of this field when represented as JSON.- Specified by:
getJsonSchema
in interfaceRestAwareField
-
getJsonFromIssue
public FieldJsonRepresentation getJsonFromIssue(Issue issue, boolean renderedVersionRequired, 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 interfaceRestAwareField
- Parameters:
issue
- to get field data fromrenderedVersionRequired
- whether the use requested the return of rendered/pretty data as well as raw datafieldLayoutItem
- 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.
-
getRestFieldOperation
- Specified by:
getRestFieldOperation
in interfaceRestFieldOperations
- Returns:
- the RestFieldOperationsHandler for this field.
-
getJsonDefaultValue
Description copied from interface:RestFieldOperations
Return The default data for this system field. May be null if there is no default.- Specified by:
getJsonDefaultValue
in interfaceRestFieldOperations
- Parameters:
issueCtx
- Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.
-
getRepresentationFromIssue
Description copied from interface:ExportableSystemField
For the given issue get an exportable representation for the field- Specified by:
getRepresentationFromIssue
in interfaceExportableSystemField
- Parameters:
issue
- to get representation for the field- Returns:
- the fields exportable representation
-