Interface OrderableField<V>
- All Superinterfaces:
Comparable
,Field
,SearchableField
- All Known Subinterfaces:
AffectedVersionsField
,ComponentsField
,ConfigurableField<V>
,CustomField
,DefaultValueField<V>
,DependentField<V>
,FixVersionsField
,IssueTypeField
,LabelsField
,ProjectField
,SummaryField
- All Known Implementing Classes:
AbstractOrderableField
,AbstractOrderableNavigableFieldImpl
,AbstractPickerFieldImpl
,AbstractTextSystemField
,AbstractUserFieldImpl
,AbstractVersionsSystemField
,AffectedVersionsSystemField
,ArchivedDateSystemField
,ArchivedUserSystemField
,AssigneeSystemField
,AttachmentSystemField
,CommentSystemField
,ComponentsSystemField
,DescriptionSystemField
,DueDateSystemField
,EnvironmentSystemField
,FixVersionsSystemField
,ImmutableCustomField
,IssueLinksSystemField
,IssueTypeSystemField
,LabelsSystemField
,MockCustomField
,MockOrderableField
,PrioritySystemField
,ProjectSystemField
,ReporterSystemField
,ResolutionSystemField
,SecurityLevelSystemField
,SummarySystemField
,TimeTrackingSystemField
,WorklogSystemField
OrderableField
s can be viewed and edited.-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionavailableForBulkEdit
(BulkEditBean bulkEditBean) Determines whether the field is available for bulk editing given the BulkEditBean.boolean
Returnstrue
if a call toremoveValueFromIssueObject(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.getBulkEditHtml
(OperationContext operationContext, webwork.action.Action action, BulkEditBean bulkEditBean, Map displayParameters) Returns HTML that should be shown when the issue is being bulk edited.getCreateHtml
(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue) Returns the HTML that should be shown when the issue is being created.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) Returns HTML that should be shown when the issue is being edited.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.getValueFromParams
(Map params) Get a field value from the map of parameters passed.getViewHtml
(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue) getViewHtml
(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters) getViewHtml
(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, V value, Map displayParameters) boolean
Checks to see if the (web) parameters contains a relevant value with which to populate the issueboolean
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
Populate the fieldValuesHolder with a value from (web) parameters.void
Used to convert from a user friendly string value and put the result into the fieldValuesHolder.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 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.SearchableField
createAssociatedSearchHandler
-
Field Details
-
TEMPLATE_DIRECTORY_PATH
- See Also:
-
MOVE_ISSUE_PARAM_KEY
- See Also:
-
NO_HEADER_PARAM_KEY
- See Also:
-
-
Method Details
-
getCreateHtml
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.- Parameters:
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- Issue- Returns:
- the HTML that should be shown when the issue is being created.
-
getCreateHtml
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.- Parameters:
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.- Returns:
- the HTML that should be shown when the issue is being created.
-
getEditHtml
String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue) Returns HTML that should be shown when the issue is being edited.- Parameters:
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- Issue- Returns:
- HTML that should be shown when the issue is being edited.
-
getEditHtml
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.- Parameters:
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.- Returns:
- HTML that should be shown when the issue is being edited.
-
getBulkEditHtml
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.- Parameters:
operationContext
- OperationContextaction
- ActionbulkEditBean
- BulkEditBeandisplayParameters
- Map of display parameters.- Returns:
- HTML that should be shown when the issue is being edited.
-
getViewHtml
-
getViewHtml
String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters) -
getViewHtml
String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, V value, Map displayParameters) -
isShown
Tests field specific way to determine if it should be shown or not.- Parameters:
issue
- The Issue.- Returns:
- true if it should be shown.
-
populateDefaults
Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.- Parameters:
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The Issue.
-
hasParam
Checks to see if the (web) parameters contains a relevant value with which to populate the issue- Parameters:
parameters
- Map of HTTP request parameters ("Action parameters").
-
populateFromParams
Populate the fieldValuesHolder with a value from (web) parameters.- Parameters:
fieldValuesHolder
- The fieldValuesHolder Map to be populated.parameters
- Map of HTTP parameters.
-
populateFromIssue
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.- Parameters:
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The Issue.
-
validateParams
void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) Ensure that the parameters are valid- 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
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.
- Parameters:
issue
- the Issue.- Returns:
- The default value. It can be null, or an empty collection.
-
createValue
Create the value of the issue in the data store.- Parameters:
issue
- Issue this field is part ofvalue
- Value to store in this field (eg. Collection for Version fields). Cannot be null.
-
updateValue
void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder) 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.
- 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
Record the value on the issue (not saving it to the database, see updateValue).- Parameters:
fieldLayoutItem
- FieldLayoutItemissue
- MutableIssuefieldValueHolder
- Field Value Holder Map- See Also:
-
removeValueFromIssueObject
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.
- Parameters:
issue
- The issue object to be effected.- See Also:
-
canRemoveValueFromIssueObject
Returnstrue
if a call toremoveValueFromIssueObject(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.
- Parameters:
issue
- The Issue object.- Returns:
true
if a call toremoveValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.- See Also:
-
needsMove
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. This method is called only if the field is visible in the target project/issue type.- 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
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.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.- Parameters:
fieldValuesHolder
- Map of field Values.originalIssue
- orignal IssuetargetIssue
- target Issue
-
hasValue
Determines if the field has a value for the given issue.- Parameters:
issue
- the Issue.- Returns:
- true if the given Issue has a value for this field.
-
availableForBulkEdit
Determines whether the field is available for bulk editing given the BulkEditBean.- 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.
-
getValueFromParams
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.- 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
void populateParamsFromString(Map<String, Object> fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationExceptionUsed 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.- 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
-