Class CommentSystemField
- All Implemented Interfaces:
ExportableSystemField,CommentField,Field,OrderableField<Map<String,,Object>> RenderableField,RestAwareField,RestFieldOperations,SearchableField,UnscreenableField,Comparable
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final StringThe parameter name of the user-chosen group or role-type "level" for restricting the comment visibilitystatic final Stringstatic final Stringstatic final StringThe parameter name of the user-chosen group-type "level" for restricting the comment visibilitystatic final Stringstatic final StringThe parameter name of the user-chosen role-type "level" for restricting the comment visibilitystatic final StringFields inherited from interface com.atlassian.jira.issue.fields.OrderableField
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH -
Constructor Summary
ConstructorsConstructorDescriptionCommentSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, RendererManager rendererManager, PermissionManager permissionManager, CommentService commentService, ProjectRoleManager projectRoleManager, CommentSearchHandlerFactory searchHandlerFactory, GroupManager groupManager, CommentManager commentManager, MentionService mentionService, CommentFieldRenderer commentFieldRenderer, DefaultCommentPropertyService commentPropertyService, I18nHelper.BeanFactory i18nFactory, CsvDateFormatter csvDateFormatter, ServiceDeskVisibilityInformationRetriever serviceDeskVisibilityInformationRetriever, CommentsPerIssueLimitValidator commentsPerIssueLimitValidator, CommentHandler commentHandler, FeatureManager featureManager, ProcessingContext processingContext) -
Method Summary
Modifier and TypeMethodDescriptionavailableForBulkEdit(BulkEditBean bulkEditBean) Determines whether the field is available for bulk editing given the BulkEditBean.booleanReturnstrueif a call toOrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)will actually remove the value.voidcreateValue(Issue issue, Map<String, Object> value) Create the value of the issue in the data store.static com.google.common.collect.ImmutableMap<String, JSONObject> getCommentPropertiesFromParameters(Map<String, Object> commentParams) 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.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.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 ObjectgetRelevantParams(Map<String, String[]> params) Defines the object that will be passed through to the create methodgetRepresentationFromIssue(Issue issue) For the given issue get an exportable representation for the fieldgetValueFromIssue(Issue issue) Gets the value stored for this field on the provided issue.getValueFromParams(Map params) Get a field value from the map of parameters passed.getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters) getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map<String, Object> value, Map displayParameters) booleanDetermines if the field has a value for the given issue.booleanDefines if a field determines itself as renderable.booleanTests 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.voidpopulateAdditionalInputs(Map fieldValuesHolder, Map<String, Object> additionalInputs) Extracts comment values from the fieldValuesHolder and places them in another map to be used by the WorkflowManager.voidpopulateDefaults(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.voidUsed to populate the fieldValueHolder with parameters for move issue screen.voidpopulateFromIssue(Map<String, Object> fieldValuesHolder, Issue issue) Used to initialise the fieldValuesHolder from the current value of teh issue.voidUsed to convert from a user friendly string value and put the result into the fieldValuesHolder.voidRemoves the field value from the given MutableIssue object.voidupdateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder) Sets the value as a modified external field in the issue so that this field will be updated along with all the other modified issue values.voidupdateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder) Update the issue in the data store.voidvalidateCommentProperties(Map<String, Object> properties, ErrorCollection errorCollection) voidvalidateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) Ensure that the parameters are validMethods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField
createAssociatedSearchHandler, getApplicationProperties, getBulkEditHtml, getCreateHtml, getEditHtml, getFieldLayoutItemForBulkOperation, getIssueForBulkOperation, getPermissionManager, getVelocityParams, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, validateBulkEditHtmlProperties, valuesEqualMethods inherited from class com.atlassian.jira.issue.fields.AbstractField
compareTo, equals, getAuthenticationContext, getId, getName, getNameKey, hashCodeMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.atlassian.jira.issue.fields.Field
getId, getName, getNameKeyMethods inherited from interface com.atlassian.jira.issue.fields.renderer.RenderableField
getId
-
Field Details
-
CREATE_COMMENT
- See Also:
-
EDIT_COMMENT
- See Also:
-
REMOVE_COMMENT
- See Also:
-
PARAM_GROUP_LEVEL
The parameter name of the user-chosen group-type "level" for restricting the comment visibility- See Also:
-
PARAM_COMMENT_LEVEL
The parameter name of the user-chosen group or role-type "level" for restricting the comment visibility- See Also:
-
PARAM_COMMENT_OBJECT
- See Also:
-
PARAM_COMMENT_PROPERTY
- See Also:
-
PARAM_ROLE_LEVEL
The parameter name of the user-chosen role-type "level" for restricting the comment visibility- See Also:
-
PARAM_COMMENT_ID
- See Also:
-
PARAM_LEVEL_PRESENT
- See Also:
-
-
Constructor Details
-
CommentSystemField
public CommentSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, RendererManager rendererManager, PermissionManager permissionManager, CommentService commentService, ProjectRoleManager projectRoleManager, CommentSearchHandlerFactory searchHandlerFactory, GroupManager groupManager, CommentManager commentManager, MentionService mentionService, CommentFieldRenderer commentFieldRenderer, DefaultCommentPropertyService commentPropertyService, I18nHelper.BeanFactory i18nFactory, CsvDateFormatter csvDateFormatter, ServiceDeskVisibilityInformationRetriever serviceDeskVisibilityInformationRetriever, CommentsPerIssueLimitValidator commentsPerIssueLimitValidator, CommentHandler commentHandler, FeatureManager featureManager, ProcessingContext processingContext)
-
-
Method Details
-
getRelevantParams
Defines the object that will be passed through to the create method- Specified by:
getRelevantParamsin classAbstractOrderableField<Map<String,Object>> - Parameters:
params- is a representation of the request params that are available- Returns:
- an object that holds the params we need for this Field.
-
getCreateHtml
public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Description copied from interface:OrderableFieldReturns the HTML that should be shown when the issue is being created.- Specified by:
getCreateHtmlin interfaceOrderableField<Map<String,Object>> - 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:OrderableFieldReturns HTML that should be shown when the issue is being edited.- Specified by:
getEditHtmlin interfaceOrderableField<Map<String,Object>> - 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:
getViewHtmlin interfaceOrderableField<Map<String,Object>>
-
getViewHtml
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map<String, Object> value, Map displayParameters) - Specified by:
getViewHtmlin interfaceOrderableField<Map<String,Object>>
-
isShown
Description copied from interface:OrderableFieldTests field specific way to determine if it should be shown or not.- Specified by:
isShownin interfaceOrderableField<Map<String,Object>> - Parameters:
issue- The Issue.- Returns:
- true if it should be shown.
-
populateDefaults
Description copied from interface:OrderableFieldPopulate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.- Specified by:
populateDefaultsin interfaceOrderableField<Map<String,Object>> - Parameters:
fieldValuesHolder- The fieldValuesHolder Map to be populated.issue- The Issue.
-
populateAdditionalInputs
Extracts comment values from the fieldValuesHolder and places them in another map to be used by the WorkflowManager. These additional inputs are required by the CreateCommentFunction to successfully create a comment.- Parameters:
fieldValuesHolder- a map containing comment values from a BulkEdit. Obtained from BulkEditBean.additionalInputs- a map to be passed onto a WorkflowManager.
-
populateFromIssue
Description copied from interface:OrderableFieldUsed 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:
populateFromIssuein interfaceOrderableField<Map<String,Object>> - Parameters:
fieldValuesHolder- The fieldValuesHolder Map to be populated.issue- The Issue.
-
validateParams
public void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) Description copied from interface:OrderableFieldEnsure that the parameters are valid- Specified by:
validateParamsin interfaceOrderableField<Map<String,Object>> - 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
-
getDefaultValue
Description copied from interface:OrderableFieldThe 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:
getDefaultValuein interfaceOrderableField<Map<String,Object>> - Parameters:
issue- the Issue.- Returns:
- The default value. It can be null, or an empty collection.
-
createValue
Description copied from interface:OrderableFieldCreate the value of the issue in the data store.- Specified by:
createValuein interfaceOrderableField<Map<String,Object>> - 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:OrderableFieldUpdate 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:
updateValuein interfaceOrderableField<Map<String,Object>> - 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
Sets the value as a modified external field in the issue so that this field will be updated along with all the other modified issue values.- Specified by:
updateIssuein interfaceOrderableField<Map<String,Object>> - Parameters:
fieldLayoutItem- FieldLayoutItemissue- MutableIssuefieldValueHolder- Field Value Holder Map- See Also:
-
needsMove
public MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem) Description copied from interface:OrderableFieldUsed 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:
needsMovein interfaceOrderableField<Map<String,Object>> - 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:OrderableFieldUsed 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:
populateForMovein interfaceOrderableField<Map<String,Object>> - Parameters:
fieldValuesHolder- Map of field Values.originalIssue- orignal IssuetargetIssue- target Issue
-
removeValueFromIssueObject
Description copied from interface:OrderableFieldRemoves 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:
removeValueFromIssueObjectin interfaceOrderableField<Map<String,Object>> - Parameters:
issue- The issue object to be effected.- See Also:
-
canRemoveValueFromIssueObject
Description copied from interface:OrderableFieldReturnstrueif 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:
canRemoveValueFromIssueObjectin interfaceOrderableField<Map<String,Object>> - Parameters:
issue- The Issue object.- Returns:
trueif a call toOrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)will actually remove the value.- See Also:
-
hasValue
Description copied from interface:OrderableFieldDetermines if the field has a value for the given issue.- Specified by:
hasValuein interfaceOrderableField<Map<String,Object>> - Parameters:
issue- the Issue.- Returns:
- true if the given Issue has a value for this field.
-
getValueFromParams
Description copied from interface:OrderableFieldGet 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:
getValueFromParamsin interfaceOrderableField<Map<String,Object>> - Parameters:
params- the map of parameters.- Returns:
- Value for this field from the map of parameters.
- Throws:
FieldValidationException- if there is a problem with Field Validation.
-
populateParamsFromString
public void populateParamsFromString(Map<String, Object> fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationExceptionDescription copied from interface:OrderableFieldUsed 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:
populateParamsFromStringin interfaceOrderableField<Map<String,Object>> - 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
-
getValueFromIssue
Description copied from interface:RenderableFieldGets the value stored for this field on the provided issue.- Specified by:
getValueFromIssuein interfaceRenderableField- Parameters:
issue- identifies the issue that will contain the value for this field.- Returns:
- the value stored on this issue for this field, null if not applicable.
-
isRenderable
public boolean isRenderable()Description copied from interface:RenderableFieldDefines 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.- Specified by:
isRenderablein interfaceRenderableField- Returns:
- true if the field is renderable, false otherwise.
-
availableForBulkEdit
Description copied from interface:OrderableFieldDetermines whether the field is available for bulk editing given the BulkEditBean.- Specified by:
availableForBulkEditin interfaceOrderableField<Map<String,Object>> - Parameters:
bulkEditBean- holds the state of the bulk-edit wizard (e.g. the selected issues for bulk editing)- Returns:
nullif the field is available for bulk-editing or an i18n key of the error message to show as why the field is not available.
-
getFieldTypeInfo
Description copied from interface:RestAwareFieldReturns lower level Information about the field. This information contains allowed values and/or the autocomplete url- Specified by:
getFieldTypeInfoin interfaceRestAwareField- Parameters:
fieldTypeInfoContext- theFieldTypeInfoContextcontains context information that is relevant to generate theFieldTypeInfo
-
getJsonSchema
Description copied from interface:RestAwareFieldReturn a description of the shape of this field when represented as JSON.- Specified by:
getJsonSchemain interfaceRestAwareField
-
getRestFieldOperation
- Specified by:
getRestFieldOperationin interfaceRestFieldOperations- Returns:
- the RestFieldOperationsHandler for this field.
-
getJsonFromIssue
public FieldJsonRepresentation getJsonFromIssue(Issue issue, boolean renderedVersionRequired, @Nullable FieldLayoutItem fieldLayoutItem) Description copied from interface:RestAwareFieldReturn 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:
getJsonFromIssuein 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.
-
getJsonDefaultValue
Description copied from interface:RestFieldOperationsReturn The default data for this system field. May be null if there is no default.- Specified by:
getJsonDefaultValuein interfaceRestFieldOperations- Parameters:
issueCtx- Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.
-
validateCommentProperties
public void validateCommentProperties(Map<String, Object> properties, ErrorCollection errorCollection) -
getCommentPropertiesFromParameters
public static com.google.common.collect.ImmutableMap<String,JSONObject> getCommentPropertiesFromParameters(Map<String, Object> commentParams) throws JSONException- Throws:
JSONException
-
getRepresentationFromIssue
Description copied from interface:ExportableSystemFieldFor the given issue get an exportable representation for the field- Specified by:
getRepresentationFromIssuein interfaceExportableSystemField- Parameters:
issue- to get representation for the field- Returns:
- the fields exportable representation
-