Class ProjectSystemField
- All Implemented Interfaces:
ExportableSystemField
,Field
,HideableField
,NavigableField
,OrderableField<Project>
,ProjectField
,RequirableField
,RestAwareField
,SearchableField
,Comparable
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
Fields inherited from class com.atlassian.jira.issue.fields.AbstractPickerFieldImpl
DEFAULT_MAX_OPTIONS_VALUE, MAX_OPTIONS_NUMBER
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
ConstructorsConstructorDescriptionProjectSystemField
(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, ProjectManager projectManager, PermissionManager permissionManager, ProjectStatisticsMapper projectStatisticsMapper, ProjectSearchHandlerFactory searchHandlerFactory, JiraBaseUrls jiraBaseUrls, ProjectSuggestionProvider projectSuggestionProvider) -
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, Project 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.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.Return a description of the shape of this field when represented as JSON.static JsonType
protected Project
getProject
(Long projectId) protected Object
getRelevantParams
(Map<String, String[]> params) getRepresentationFromIssue
(Issue issue) Includes all of the issue's project details into an export value.A sorter to be used when sorting columns in a table.getValueFromParams
(Map params) Get a field value from the map of parameters passed.getViewHtml
(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Project 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) Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.void
Used to populate the fieldValueHolder with parameters for move issue screen.void
populateFromIssue
(Map<String, Object> fieldValuesHolder, Issue issue) Used to initialise the fieldValuesHolder from the current value of teh issue.void
Used to convert from a user friendly string value and put the result into the fieldValuesHolder.void
populateProjects
(OperationContext operationContext, Map<String, Object> velocityParams) void
populateProjects
(OperationContext operationContext, Map<String, Object> velocityParams, boolean includeRecent) void
Removes the field value from the given MutableIssue object.void
updateIssue
(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder) Record the value on the issue (not saving it to the database, see updateValue).void
updateValue
(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder) Update the issue in the data store.void
validateParams
(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) Ensure that the parameters are validMethods inherited from class com.atlassian.jira.issue.fields.AbstractPickerFieldImpl
getVelocityParams, shouldUseRestEndpoint, userPickerEnabled
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl
getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getSortFields, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory
Methods 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
getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getSortFields, prettyPrintChangeHistory, prettyPrintChangeHistory, prettyPrintChangeHistory
Methods inherited from interface com.atlassian.jira.issue.fields.OrderableField
getCreateHtml, getEditHtml, getViewHtml, hasParam, populateFromParams
Methods inherited from interface com.atlassian.jira.issue.fields.SearchableField
createAssociatedSearchHandler
-
Field Details
-
PROJECT_NAME_KEY
- See Also:
-
EXPORT_KEY_ID
- See Also:
-
EXPORT_PROJECT_NAME_ID
- See Also:
-
EXPORT_PROJECT_DESCRIPTION_ID
- See Also:
-
EXPORT_PROJECT_TYPE_ID
- See Also:
-
EXPORT_PROJECT_LEAD_ID
- See Also:
-
EXPORT_PROJECT_URL_ID
- See Also:
-
-
Constructor Details
-
ProjectSystemField
public ProjectSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, ProjectManager projectManager, PermissionManager permissionManager, ProjectStatisticsMapper projectStatisticsMapper, ProjectSearchHandlerFactory searchHandlerFactory, JiraBaseUrls jiraBaseUrls, ProjectSuggestionProvider projectSuggestionProvider)
-
-
Method Details
-
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<Project>
- Parameters:
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.- Returns:
- the HTML that should be shown when the issue is being created.
-
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<Project>
- Overrides:
getBulkEditHtml
in classAbstractOrderableField<Project>
- Parameters:
operationContext
- OperationContextaction
- ActionbulkEditBean
- BulkEditBeandisplayParameters
- Map of display parameters.- Returns:
- HTML that should be shown when the issue is being edited.
-
populateProjects
-
populateProjects
public void populateProjects(OperationContext operationContext, Map<String, Object> velocityParams, boolean includeRecent) -
availableForBulkEdit
Description copied from interface:OrderableField
Determines whether the field is available for bulk editing given the BulkEditBean.- Specified by:
availableForBulkEdit
in interfaceOrderableField<Project>
- 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.
-
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<Project>
- 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<Project>
-
getViewHtml
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Project value, Map displayParameters) - Specified by:
getViewHtml
in interfaceOrderableField<Project>
-
validateParams
public void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) Description copied from interface:OrderableField
Ensure that the parameters are valid- Specified by:
validateParams
in interfaceOrderableField<Project>
- Parameters:
operationContext
- OperationContexterrorCollectionToAddTo
- 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
-
getRelevantParams
- Specified by:
getRelevantParams
in classAbstractOrderableField<Project>
-
getProject
-
getValueFromParams
Description copied from interface:OrderableField
Get a field value from the map of parameters passed. The params map may contain other parameters that are not relevant to this custom field.- Specified by:
getValueFromParams
in interfaceOrderableField<Project>
- Parameters:
params
- the map of parameters.- Returns:
- Value for this field from the map of parameters.
-
populateParamsFromString
public void populateParamsFromString(Map<String, Object> fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationExceptionDescription copied from interface:OrderableField
Used to convert from a user friendly string value and put the result into the fieldValuesHolder. This method is useful for places like Jelly where the field value can be a name (e.g. issue type name) and not a regular id that is used in the web pages.- Specified by:
populateParamsFromString
in interfaceOrderableField<Project>
- Parameters:
fieldValuesHolder
- Map of field Values.stringValue
- user friendly string valueissue
- the Issue- Throws:
FieldValidationException
- if cannot convert to a value from the given string
-
getAllowedProjects
-
isShown
Description copied from interface:OrderableField
Tests field specific way to determine if it should be shown or not.- Specified by:
isShown
in interfaceOrderableField<Project>
- Parameters:
issue
- The Issue.- Returns:
- true if it should be shown.
-
populateDefaults
Description copied from interface:OrderableField
Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.- Specified by:
populateDefaults
in interfaceOrderableField<Project>
- Parameters:
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The Issue.
-
populateFromIssue
Description copied from interface:OrderableField
Used to initialise the fieldValuesHolder from the current value of teh issue. Used, for example, when showing the Edit Issue screen to show the issue's current values.- Specified by:
populateFromIssue
in interfaceOrderableField<Project>
- Parameters:
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The Issue.
-
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<Project>
- Parameters:
issue
- the Issue.- Returns:
- The default value. It can be null, or an empty collection.
-
createValue
Description copied from interface:OrderableField
Create the value of the issue in the data store.- Specified by:
createValue
in interfaceOrderableField<Project>
- Parameters:
issue
- Issue this field is part ofvalue
- Value to store in this field (eg. Collection for Version fields). Cannot be null.
-
updateValue
public void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder) Description copied from interface:OrderableField
Update the issue in the data store.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.
- Specified by:
updateValue
in interfaceOrderableField<Project>
- Parameters:
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.
-
updateIssue
Description copied from interface:OrderableField
Record the value on the issue (not saving it to the database, see updateValue).- Specified by:
updateIssue
in interfaceOrderableField<Project>
- Parameters:
fieldLayoutItem
- FieldLayoutItemissue
- MutableIssuefieldValueHolder
- Field Value Holder Map- See Also:
-
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<Project>
- 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.
-
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<Project>
- Parameters:
fieldValuesHolder
- Map of field Values.originalIssue
- orignal IssuetargetIssue
- target Issue
-
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<Project>
- Parameters:
issue
- The issue object to be effected.- See Also:
-
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<Project>
- 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<Project>
- Parameters:
issue
- the Issue.- Returns:
- true if the given Issue has a value for this field.
-
getColumnHeadingKey
- Specified by:
getColumnHeadingKey
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
-
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:
-
getColumnViewHtml
- Specified by:
getColumnViewHtml
in interfaceNavigableField
-
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
-
getJsonType
-
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 interfaceRestAwareField
- Parameters:
issue
- to get field data fromrenderedVersionRequested
- 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.
-
getRepresentationFromIssue
Includes all of the issue's project details into an export value. For example in the CSV output it would look like: {pre} Project Key, Project Name, ... HSP,Homosapiens, ... {/pre}- Specified by:
getRepresentationFromIssue
in interfaceExportableSystemField
- Parameters:
issue
- to get export representation for- Returns:
- export representation of this field
-