public abstract class AbstractVersionsSystemField extends AbstractOrderableNavigableFieldImpl<Collection<Version>> implements HideableField, RequirableField, RestAwareField, ExportableSystemField
Modifier and Type | Field and Description |
---|---|
static Long |
RELEASED_VERSION_ID |
protected SearchLinkGenerator |
searchLinkGenerator |
static Long |
UNKNOWN_VERSION_ID |
static Long |
UNRELEASED_VERSION_ID |
protected VersionHelperBean |
versionHelperBean |
protected VersionManager |
versionManager |
authenticationContext
ORDER_ASCENDING, ORDER_DESCENDING, TEMPLATE_DIRECTORY_PATH
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH
Constructor and Description |
---|
AbstractVersionsSystemField(String id,
String name,
VelocityTemplatingEngine templatingEngine,
ApplicationProperties applicationProperties,
VersionManager versionManager,
PermissionManager permissionManager,
JiraAuthenticationContext authenticationContext,
VersionHelperBean versionHelperBean,
SearchHandlerFactory searchHandlerFactory,
SearchLinkGenerator searchLinkGenerator,
JiraBaseUrls jiraBaseUrls,
JqlStringSupport jqlStringSupport) |
Modifier and Type | Method and Description |
---|---|
protected abstract void |
addFieldRequiredErrorMessage(Issue issue,
ErrorCollection errorCollectionToAddTo,
I18nHelper i18n) |
protected Map<String,Object> |
addViewVelocityParams() |
String |
availableForBulkEdit(BulkEditBean bulkEditBean)
Determines whether the field is available for bulk editing given the BulkEditBean.
|
void |
createValue(Issue issue,
Collection<Version> value)
Create the value of the issue in the data store.
|
protected abstract String |
getArchivedVersionsFieldTitle() |
String |
getBulkEditHtml(OperationContext operationContext,
webwork.action.Action action,
BulkEditBean bulkEditBean,
Map displayParameters)
Returns HTML that should be shown when a version field is being bulk edited.
|
protected abstract String |
getChangeItemFieldName() |
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.
|
protected LongIdsValueHolder |
getCurrentVersionIds(Issue issue) |
protected abstract Collection<Version> |
getCurrentVersions(Issue issue) |
String |
getDefaultSortOrder()
The order in which to sort the field when it is sorted for the first time.
|
Collection<Version> |
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.
|
protected abstract String |
getIssueRelationName() |
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 abstract String |
getModifiedWithoutPermissionErrorMessage(I18nHelper i18n) |
protected List<VersionProxy> |
getPossibleVersions(Project project,
boolean unreleasedFirst) |
protected Object |
getRelevantParams(Map<String,String[]> params) |
FieldExportParts |
getRepresentationFromIssue(Issue issue)
For the given issue get an exportable representation for the field
|
protected abstract boolean |
getUnreleasedVersionsFirst() |
Collection<Version> |
getValueFromParams(Map params)
Get a field value from the map of parameters passed.
|
protected VersionManager |
getVersionManager() |
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue,
Collection<Version> value,
Map displayParameters) |
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue,
Map displayParameters) |
boolean |
hasValue(Issue issue)
Determines if the field has a value for the given issue.
|
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)
Populate the fieldValueHolder with a value that should be shown by default when the issue
has not been created yet.
|
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> params,
Issue issue)
Used to initialise the fieldValuesHolder from the current value of teh issue.
|
void |
populateParamsFromString(Map<String,Object> fieldValuesHolder,
String stringValue,
Issue issue)
Used to convert from a user friendly string value and put the result into the fieldValuesHolder.
|
protected abstract JqlClauseBuilder |
queryArchivedVersionsField(JqlClauseBuilder and,
Version name) |
protected abstract List<ChangeItemBean> |
updateIssueValue(Issue issue,
Collection<Version> newValue) |
void |
updateValue(FieldLayoutItem fieldLayoutItem,
Issue issue,
ModifiedValue modifiedValue,
IssueChangeHolder issueChangeHolder)
Update the issue in the data store.
|
void |
validateParams(OperationContext operationContext,
ErrorCollection errorCollection,
I18nHelper i18n,
Issue issue,
FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
Ensure that the parameters are valid
|
getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getSortFields, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory
createAssociatedSearchHandler, getApplicationProperties, getCreateHtml, getEditHtml, getFieldLayoutItemForBulkOperation, getIssueForBulkOperation, getPermissionManager, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, validateBulkEditHtmlProperties, valuesEqual
compareTo, equals, getAuthenticationContext, getId, getName, getNameKey, hashCode
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
getId, getName, getNameKey
compareTo
getColumnHeadingKey, getSorter, prettyPrintChangeHistory
canRemoveValueFromIssueObject, isShown, removeValueFromIssueObject, updateIssue
public static final Long UNKNOWN_VERSION_ID
public static final Long UNRELEASED_VERSION_ID
public static final Long RELEASED_VERSION_ID
protected final VersionManager versionManager
protected final VersionHelperBean versionHelperBean
protected final SearchLinkGenerator searchLinkGenerator
public AbstractVersionsSystemField(String id, String name, VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, VersionManager versionManager, PermissionManager permissionManager, JiraAuthenticationContext authenticationContext, VersionHelperBean versionHelperBean, SearchHandlerFactory searchHandlerFactory, SearchLinkGenerator searchLinkGenerator, JiraBaseUrls jiraBaseUrls, JqlStringSupport jqlStringSupport)
public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
OrderableField
getCreateHtml
in interface OrderableField<Collection<Version>>
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<Collection<Version>>
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.public String getBulkEditHtml(OperationContext operationContext, webwork.action.Action action, BulkEditBean bulkEditBean, Map displayParameters)
The HTML displayed for Bulk Move of Versions needs to allow the user to specify mappings for each old version present in the currently selected issues.
getBulkEditHtml
in interface OrderableField<Collection<Version>>
getBulkEditHtml
in class AbstractOrderableField<Collection<Version>>
operationContext
- OperationContextaction
- ActionbulkEditBean
- BulkEditBeandisplayParameters
- Map of display parameters.public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
getViewHtml
in interface OrderableField<Collection<Version>>
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Collection<Version> value, Map displayParameters)
getViewHtml
in interface OrderableField<Collection<Version>>
protected Object getRelevantParams(Map<String,String[]> params)
getRelevantParams
in class AbstractOrderableField<Collection<Version>>
public Collection<Version> getValueFromParams(Map params)
OrderableField
getValueFromParams
in interface OrderableField<Collection<Version>>
params
- the map of parameters.public void populateParamsFromString(Map<String,Object> fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationException
OrderableField
populateParamsFromString
in interface OrderableField<Collection<Version>>
fieldValuesHolder
- Map of field Values.stringValue
- user friendly string valueissue
- the IssueFieldValidationException
- if cannot convert to a value from the given stringpublic void populateFromIssue(Map<String,Object> params, Issue issue)
OrderableField
populateFromIssue
in interface OrderableField<Collection<Version>>
params
- The fieldValuesHolder Map to be populated.issue
- The Issue.protected LongIdsValueHolder getCurrentVersionIds(Issue issue)
protected abstract Collection<Version> getCurrentVersions(Issue issue)
protected abstract String getArchivedVersionsFieldTitle()
protected abstract JqlClauseBuilder queryArchivedVersionsField(JqlClauseBuilder and, Version name)
protected abstract boolean getUnreleasedVersionsFirst()
protected List<VersionProxy> getPossibleVersions(Project project, boolean unreleasedFirst)
public void validateParams(OperationContext operationContext, ErrorCollection errorCollection, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
OrderableField
validateParams
in interface OrderableField<Collection<Version>>
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
- FieldScreenRenderLayoutItemprotected abstract void addFieldRequiredErrorMessage(Issue issue, ErrorCollection errorCollectionToAddTo, I18nHelper i18n)
protected abstract String getModifiedWithoutPermissionErrorMessage(I18nHelper i18n)
public void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
OrderableField
Fields that are simply stored in the JIRAISSUE DB table, need not do anything here as this table is written to one time to include all fields that changed. Fields using other DB tables must update that table with the appropriate values.
updateValue
in interface OrderableField<Collection<Version>>
fieldLayoutItem
- for this field within this contextissue
- Issue this field is part ofmodifiedValue
- 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<Collection<Version>>
originalIssues
- Collection of original Issues.targetIssue
- Nonexistent issue object with values representing those of issue(s) after movetargetFieldLayoutItem
- FieldLayoutItempublic 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<Collection<Version>>
fieldValuesHolder
- Map of field Values.originalIssue
- orignal IssuetargetIssue
- target Issuepublic boolean hasValue(Issue issue)
OrderableField
hasValue
in interface OrderableField<Collection<Version>>
issue
- the Issue.protected abstract List<ChangeItemBean> updateIssueValue(Issue issue, Collection<Version> newValue)
public void createValue(Issue issue, Collection<Version> value)
OrderableField
createValue
in interface OrderableField<Collection<Version>>
issue
- Issue this field is part ofvalue
- Value to store in this field (eg. Collection for Version fields). Cannot be null.public void populateDefaults(Map<String,Object> fieldValuesHolder, Issue issue)
OrderableField
populateDefaults
in interface OrderableField<Collection<Version>>
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The Issue.public Collection<Version> 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<Collection<Version>>
issue
- the Issue.protected abstract String getChangeItemFieldName()
protected abstract String getIssueRelationName()
protected VersionManager getVersionManager()
public String getDefaultSortOrder()
NavigableField
getDefaultSortOrder
in interface NavigableField
NavigableField.ORDER_ASCENDING
or NavigableField.ORDER_DESCENDING
public String getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
getColumnViewHtml
in interface NavigableField
public String availableForBulkEdit(BulkEditBean bulkEditBean)
OrderableField
availableForBulkEdit
in interface OrderableField<Collection<Version>>
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 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 FieldExportParts getRepresentationFromIssue(Issue issue)
ExportableSystemField
getRepresentationFromIssue
in interface ExportableSystemField
issue
- to get representation for the fieldCopyright © 2002-2022 Atlassian. All Rights Reserved.