|
||||||||||
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.CommentSystemField
public class CommentSystemField
Defines a comment in Jira.
Field Summary | |
---|---|
static String |
CREATE_COMMENT
|
static String |
PARAM_COMMENT_LEVEL
The parameter name of the user-chosen group or role-type "level" for restricting the comment visibility |
static String |
PARAM_GROUP_LEVEL
The parameter name of the user-chosen group-type "level" for restricting the comment visibility |
static String |
PARAM_ROLE_LEVEL
The parameter name of the user-chosen role-type "level" for restricting the comment visibility |
Fields inherited from interface com.atlassian.jira.issue.fields.OrderableField |
---|
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH |
Constructor Summary | |
---|---|
CommentSystemField(com.atlassian.velocity.VelocityManager velocityManager,
ApplicationProperties applicationProperties,
JiraAuthenticationContext authenticationContext,
RendererManager rendererManager,
PermissionManager permissionManager,
CommentService commentService,
ProjectRoleManager projectRoleManager,
ProjectFactory projectFactory)
|
Method Summary | |
---|---|
String |
availableForBulkEdit(BulkEditBean bulkEditBean)
Determines whether the field is available for bulk editing given the BulkEditBean. |
void |
createValue(Issue issue,
Object value)
Create the value of the issue in the data store. |
List |
getAssociatedSearchers()
Returns a list of searchers associated with field |
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 |
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 |
protected Object |
getRelevantParams(Map params)
Defines the object that will be passed through to the create method |
String |
getValueFromIssue(Issue issue)
Gets the value stored for this field on the provided issue. |
Object |
getValueFromParams(Map params)
Get a field value from the map of parameters passed. |
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 |
isRenderable()
Defines if a field determines itself as renderable. |
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 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 fieldValuesHolder,
Issue originalIssue,
Issue targetIssue)
Used to populate the fieldValueHolder with parameters for move issue screen. |
void |
populateFromIssue(Map fieldValuesHolder,
Issue issue)
Used to initialise the fieldValuesHolder from the current value of teh issue. |
void |
populateParamsFromString(Map fieldValuesHolder,
String stringValue,
Issue issue)
Used to convert from a user friendly string value and put the result into the fieldValuesHolder. |
void |
removeValue(MutableIssue issue)
Removes the value for the given issue. |
void |
updateIssue(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. |
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 valid |
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField |
---|
getApplicationProperties, getBulkEditHtml, getCreateHtml, getEditHtml, getPermissionManager, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, 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.renderer.RenderableField |
---|
getId |
Field Detail |
---|
public static final String CREATE_COMMENT
public static final String PARAM_GROUP_LEVEL
public static final String PARAM_COMMENT_LEVEL
public static final String PARAM_ROLE_LEVEL
Constructor Detail |
---|
public CommentSystemField(com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, RendererManager rendererManager, PermissionManager permissionManager, CommentService commentService, ProjectRoleManager projectRoleManager, ProjectFactory projectFactory)
Method Detail |
---|
protected Object getRelevantParams(Map params)
getRelevantParams
in class AbstractOrderableField
params
- is a representation of the request params that are available
public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
OrderableField
getCreateHtml
in interface OrderableField
public String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
OrderableField
getEditHtml
in interface OrderableField
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 boolean isShown(Issue issue)
OrderableField
isShown
in interface OrderableField
public void populateDefaults(Map fieldValuesHolder, Issue issue)
OrderableField
populateDefaults
in interface OrderableField
public void populateFromIssue(Map fieldValuesHolder, Issue issue)
OrderableField
populateFromIssue
in interface OrderableField
public void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
OrderableField
validateParams
in interface OrderableField
issue
- this is passed to get the value of other fields that may or may not have been modifiedpublic Object getDefaultValue(Issue issue)
OrderableField
getDefaultValue
in interface OrderableField
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 void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
OrderableField
updateValue
in interface OrderableField
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 void updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder)
updateIssue
in interface OrderableField
public MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)
OrderableField
needsMove
in interface OrderableField
public void populateForMove(Map 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
public void removeValue(MutableIssue issue)
OrderableField
removeValue
in interface OrderableField
public boolean hasValue(Issue issue)
OrderableField
hasValue
in interface OrderableField
public Object getValueFromParams(Map params) throws FieldValidationException
OrderableField
getValueFromParams
in interface OrderableField
FieldValidationException
public void populateParamsFromString(Map fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationException
OrderableField
populateParamsFromString
in interface OrderableField
FieldValidationException
- if cannot convert to a value from the given stringpublic List getAssociatedSearchers()
SearchableField
getAssociatedSearchers
in interface SearchableField
Class
objects of type @IssueSearcher
. Empty list if no searchers are required.
Must not be nullpublic String getValueFromIssue(Issue issue)
RenderableField
getValueFromIssue
in interface RenderableField
issue
- identifies the issue that will contain the value for this field.
public boolean isRenderable()
RenderableField
isRenderable
in interface RenderableField
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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |