@PublicApi public interface OrderableField<V> extends Field, SearchableField
OrderableField
s can be viewed and edited.Modifier and Type | Field and Description |
---|---|
static String |
MOVE_ISSUE_PARAM_KEY |
static String |
NO_HEADER_PARAM_KEY |
static String |
TEMPLATE_DIRECTORY_PATH |
Modifier and Type | Method and Description |
---|---|
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 removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value. |
void |
createValue(Issue issue,
V 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 |
getCreateHtml(FieldLayoutItem fieldLayoutItem,
OperationContext operationContext,
webwork.action.Action action,
Issue issue)
Returns the HTML that should be shown when the issue is being created.
|
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.
|
V |
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)
Returns HTML that should be shown when the issue is being edited.
|
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.
|
V |
getValueFromParams(Map params)
Get a field value from the map of parameters passed.
|
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue) |
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue,
Map displayParameters) |
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue,
V value,
Map displayParameters) |
boolean |
hasParam(Map<String,String[]> parameters)
Checks to see if the (web) parameters contains a relevant value with which to populate the issue
|
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)
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> fieldValuesHolder,
Issue issue)
Used to initialise the fieldValuesHolder from the current value of teh issue.
|
void |
populateFromParams(Map<String,Object> fieldValuesHolder,
Map<String,String[]> parameters)
Populate the fieldValuesHolder with a value from (web) parameters.
|
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.
|
void |
removeValueFromIssueObject(MutableIssue issue)
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 valid
|
createAssociatedSearchHandler
getId, getName, getNameKey
compareTo
static final String TEMPLATE_DIRECTORY_PATH
static final String MOVE_ISSUE_PARAM_KEY
static final String NO_HEADER_PARAM_KEY
String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue)
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssueString getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue)
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssueString getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.String getBulkEditHtml(OperationContext operationContext, webwork.action.Action action, BulkEditBean bulkEditBean, Map displayParameters)
operationContext
- OperationContextaction
- ActionbulkEditBean
- BulkEditBeandisplayParameters
- Map of display parameters.String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue)
String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, V value, Map displayParameters)
boolean isShown(Issue issue)
issue
- The Issue.void populateDefaults(Map<String,Object> fieldValuesHolder, Issue issue)
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The Issue.boolean hasParam(Map<String,String[]> parameters)
parameters
- Map of HTTP request parameters ("Action parameters").void populateFromParams(Map<String,Object> fieldValuesHolder, Map<String,String[]> parameters)
fieldValuesHolder
- The fieldValuesHolder Map to be populated.parameters
- Map of HTTP parameters.void populateFromIssue(Map<String,Object> fieldValuesHolder, Issue issue)
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The Issue.void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
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@Nullable V getDefaultValue(Issue issue)
For example: The user does not have permission to see the field, or the field is not part of the create screen.
issue
- the Issue.void createValue(Issue issue, V value)
issue
- Issue this field is part ofvalue
- Value to store in this field (eg. Collection for Version fields). Cannot be null.void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
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.
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.void updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder)
fieldLayoutItem
- FieldLayoutItemissue
- MutableIssuefieldValueHolder
- Field Value Holder MapupdateValue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.ModifiedValue, com.atlassian.jira.issue.util.IssueChangeHolder)
void removeValueFromIssueObject(MutableIssue issue)
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.
issue
- The issue object to be effected.canRemoveValueFromIssueObject(com.atlassian.jira.issue.Issue)
,
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)
boolean canRemoveValueFromIssueObject(Issue issue)
true
if a call to removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.
There a few different reasons why this method may return false:
issue
- The Issue object.true
if a call to removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)
originalIssues
- Collection of original Issues.targetIssue
- Target Issue.targetFieldLayoutItem
- FieldLayoutItemvoid populateForMove(Map<String,Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue)
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.fieldValuesHolder
- Map of field Values.originalIssue
- orignal IssuetargetIssue
- target Issueboolean hasValue(Issue issue)
issue
- the Issue.String availableForBulkEdit(BulkEditBean bulkEditBean)
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.V getValueFromParams(Map params) throws FieldValidationException
params
- the map of parameters.FieldValidationException
- if there is a problem with Field Validation.void populateParamsFromString(Map<String,Object> fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationException
fieldValuesHolder
- Map of field Values.stringValue
- user friendly string valueissue
- the IssueFieldValidationException
- if cannot convert to a value from the given stringCopyright © 2002-2016 Atlassian. All Rights Reserved.