|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.fields.AbstractField com.atlassian.jira.issue.fields.AbstractOrderableField com.atlassian.jira.issue.fields.IssueLinksSystemField
public class IssueLinksSystemField
Nested Class Summary | |
---|---|
static interface |
IssueLinksSystemField.IssueLinkingValue
This interface is used as a value object for IssueLinking information. |
Field Summary | |
---|---|
static String |
PARAMS_ISCREATEISSUE
|
static String |
PARAMS_ISSUE_KEYS
|
static String |
PARAMS_LINK_TYPE
|
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 |
Fields inherited from interface com.atlassian.jira.issue.fields.OrderableField |
---|
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH |
Constructor Summary | |
---|---|
IssueLinksSystemField(VelocityTemplatingEngine templatingEngine,
ApplicationProperties applicationProperties,
JiraAuthenticationContext authenticationContext,
PermissionManager permissionManager,
IssueLinkService issueLinkService,
UserHistoryManager userHistoryManager,
IssueLinkManager issueLinkManager,
IssueLinksBeanBuilderFactory issueLinkBeanBuilderFactory,
I18nHelper.BeanFactory i18nFactory,
IssueLinkTypeFinder issueLinkTypeFinder,
JiraBaseUrls jiraBaseUrls)
|
Method Summary | |
---|---|
String |
availableForBulkEdit(BulkEditBean bulkEditBean)
Determines whether the field is available for bulk editing given the BulkEditBean. |
boolean |
canRemoveValueFromIssueObject(Issue issue)
Returns true if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value. |
void |
createValue(Issue issue,
Object value)
Create the value of the issue in the data store. |
String |
getBulkEditHtml(OperationContext operationContext,
webwork.action.Action action,
BulkEditBean bulkEditBean,
Map displayParameters)
Returns HTML that should be shown when the issue is being bulk edited. |
String |
getColumnCssClass()
|
String |
getColumnHeadingKey()
|
String |
getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
Map displayParams,
Issue issue)
|
String |
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. |
String |
getDefaultSortOrder()
The order in which to sort the field when it is sorted for the first time. |
Object |
getDefaultValue(Issue issue)
The value that should be set on the issue if the field is not shown for some reason. |
String |
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. |
FieldTypeInfo |
getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
Returns lower level Information about the field. |
String |
getHiddenFieldId()
Returns the id of the field to check for visibility. |
JsonData |
getJsonDefaultValue(IssueContext issueCtx)
Return The default data for this system field. |
FieldJsonRepresentation |
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. |
JsonType |
getJsonSchema()
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. |
RestFieldOperationsHandler |
getRestFieldOperation()
|
org.apache.lucene.search.FieldComparatorSource |
getSortComparatorSource()
A sortComparatorSource object to be used for sorting columns in a table. |
LuceneFieldSorter |
getSorter()
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. |
Object |
getValueFromParams(Map fieldValueHolder)
This is called from BulkEdit/BulkWorkflowTransition to get an value object from a input set of values. |
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue,
Map displayParameters)
|
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue,
Object value,
Map displayParameters)
|
boolean |
hasValue(Issue issue)
Determines if the field has a value for the given issue. |
boolean |
isShown(Issue issue)
Tests field specific way to determine if it should be shown or not. |
MessagedResult |
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 |
populateForMove(Map<String,Object> fieldValuesHolder,
Issue originalIssue,
Issue targetIssue)
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 |
populateParamsFromString(Map<String,Object> fieldValuesHolder,
String stringValue,
Issue issue)
This is called by Jelly code to map a value into a field values holder. |
String |
prettyPrintChangeHistory(String changeHistory)
|
String |
prettyPrintChangeHistory(String changeHistory,
I18nHelper i18nHelper)
Used for email notification templates - allows changelog to be displayed in language of the recipient. |
void |
removeValueFromIssueObject(MutableIssue issue)
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 valid |
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField |
---|
createAssociatedSearchHandler, getApplicationProperties, getCreateHtml, getEditHtml, getPermissionManager, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, 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 com.atlassian.jira.issue.fields.Field |
---|
getId, getName, getNameKey |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
public static final String PARAMS_ISCREATEISSUE
public static final String PARAMS_LINK_TYPE
public static final String PARAMS_ISSUE_KEYS
Constructor Detail |
---|
public IssueLinksSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, IssueLinkService issueLinkService, UserHistoryManager userHistoryManager, IssueLinkManager issueLinkManager, IssueLinksBeanBuilderFactory issueLinkBeanBuilderFactory, I18nHelper.BeanFactory i18nFactory, IssueLinkTypeFinder issueLinkTypeFinder, JiraBaseUrls jiraBaseUrls)
Method Detail |
---|
public LuceneFieldSorter getSorter()
NavigableField
getSorter
in interface NavigableField
NavigableField.getSortComparatorSource()
DocumentIssueImpl
,
MappedSortComparator
public List<org.apache.lucene.search.SortField> getSortFields(boolean sortOrder)
NavigableField
return Collections.singletonList(new SortField(fieldName, sortOrder));
NavigableField.getSortComparatorSource()
If you implement this method there is no need to implement NavigableField.getSortComparatorSource()
.
getSortFields
in interface NavigableField
public String getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
getColumnViewHtml
in interface NavigableField
public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
OrderableField
getCreateHtml
in interface OrderableField
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.
public String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
OrderableField
getEditHtml
in interface OrderableField
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
getViewHtml
in interface OrderableField
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Object value, Map displayParameters)
getViewHtml
in interface OrderableField
public String getBulkEditHtml(OperationContext operationContext, webwork.action.Action action, BulkEditBean bulkEditBean, Map displayParameters)
AbstractOrderableField
OrderableField.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 for FieldLayoutItem
and the first issue in the collection}
getBulkEditHtml
in interface OrderableField
getBulkEditHtml
in class AbstractOrderableField
operationContext
- OperationContextaction
- ActionbulkEditBean
- BulkEditBeandisplayParameters
- Map of display parameters.
public void createValue(Issue issue, Object value)
OrderableField
createValue
in interface OrderableField
issue
- Issue this field is part ofvalue
- Value to store in this field (eg. Collection for Version fields). Cannot be null.public Object getDefaultValue(Issue issue)
OrderableField
For example: The user does not have permission to see the field, or the field is not part of the create screen.
getDefaultValue
in interface OrderableField
issue
- the Issue.
public void populateDefaults(Map<String,Object> fieldValuesHolder, Issue issue)
populateDefaults
in interface OrderableField
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The issue in play.public void populateParamsFromString(Map<String,Object> fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationException
populateParamsFromString
in interface OrderableField
fieldValuesHolder
- Map of field Values.stringValue
- user friendly string value.issue
- the issue in play.
FieldValidationException
- if cannot convert to a value from the given stringpublic void populateForMove(Map<String,Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue)
OrderableField
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.
populateForMove
in interface OrderableField
fieldValuesHolder
- Map of field Values.originalIssue
- orignal IssuetargetIssue
- target Issueprotected Object getRelevantParams(Map<String,String[]> inputParameters)
getRelevantParams
in class AbstractOrderableField
inputParameters
- the input parameters.
public void populateFromIssue(Map<String,Object> fieldValuesHolder, Issue issue)
populateFromIssue
in interface OrderableField
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The issue in play.public void validateParams(OperationContext operationContext, ErrorCollection errorCollection, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
OrderableField
validateParams
in interface OrderableField
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
- FieldScreenRenderLayoutItempublic Object getValueFromParams(Map fieldValueHolder)
getValueFromParams
in interface OrderableField
fieldValueHolder
- the map of parameters.
public 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.
This is called prior to the issue being stored on disk.
updateIssue
in interface OrderableField
fieldLayoutItem
- FieldLayoutItem in play.issue
- MutableIssue in play.fieldValueHolder
- Field Value Holder Map.OrderableField.updateValue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.ModifiedValue, com.atlassian.jira.issue.util.IssueChangeHolder)
public void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
updateValue
in interface OrderableField
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.public MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)
OrderableField
needsMove
in interface OrderableField
originalIssues
- Collection of original Issues.targetIssue
- Target Issue.targetFieldLayoutItem
- FieldLayoutItem
public void removeValueFromIssueObject(MutableIssue issue)
OrderableField
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.
removeValueFromIssueObject
in interface OrderableField
issue
- The issue object to be effected.OrderableField.canRemoveValueFromIssueObject(com.atlassian.jira.issue.Issue)
,
OrderableField.updateValue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.ModifiedValue, com.atlassian.jira.issue.util.IssueChangeHolder)
public boolean isShown(Issue issue)
OrderableField
isShown
in interface OrderableField
issue
- The Issue.
public boolean canRemoveValueFromIssueObject(Issue issue)
OrderableField
true
if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.
There a few different reasons why this method may return false:
canRemoveValueFromIssueObject
in interface OrderableField
issue
- The Issue object.
true
if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
public boolean hasValue(Issue issue)
OrderableField
hasValue
in interface OrderableField
issue
- the Issue.
public String availableForBulkEdit(BulkEditBean bulkEditBean)
OrderableField
availableForBulkEdit
in interface OrderableField
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.public String getColumnHeadingKey()
getColumnHeadingKey
in interface NavigableField
public String getColumnCssClass()
getColumnCssClass
in interface NavigableField
public String getDefaultSortOrder()
NavigableField
getDefaultSortOrder
in interface NavigableField
NavigableField.ORDER_ASCENDING
or NavigableField.ORDER_DESCENDING
public org.apache.lucene.search.FieldComparatorSource getSortComparatorSource()
NavigableField
MappedSortComparator
using the NavigableField.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.
getSortComparatorSource
in interface NavigableField
public String getHiddenFieldId()
NavigableField
getHiddenFieldId
in interface NavigableField
public String prettyPrintChangeHistory(String changeHistory)
prettyPrintChangeHistory
in interface NavigableField
public String prettyPrintChangeHistory(String changeHistory, I18nHelper i18nHelper)
NavigableField
prettyPrintChangeHistory
in interface NavigableField
public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
RestAwareField
getFieldTypeInfo
in interface RestAwareField
fieldTypeInfoContext
- the FieldTypeInfoContext
contains context information that is relevant to generate the FieldTypeInfo
public JsonType getJsonSchema()
RestAwareField
getJsonSchema
in interface RestAwareField
public FieldJsonRepresentation getJsonFromIssue(Issue issue, boolean renderedVersionRequired, FieldLayoutItem fieldLayoutItem)
RestAwareField
getJsonFromIssue
in interface RestAwareField
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.
public RestFieldOperationsHandler getRestFieldOperation()
getRestFieldOperation
in interface RestFieldOperations
public JsonData getJsonDefaultValue(IssueContext issueCtx)
RestFieldOperations
getJsonDefaultValue
in interface RestFieldOperations
issueCtx
- Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |