public class PrioritySystemField extends AbstractOrderableNavigableFieldImpl<Priority> implements ConfigurableField<Priority>, HideableField, RequirableField, IssueConstantsField, RestAwareField, RestFieldOperations, ExportableSystemField
authenticationContextMOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATHORDER_ASCENDING, ORDER_DESCENDING, TEMPLATE_DIRECTORY_PATH| Constructor and Description |
|---|
PrioritySystemField(VelocityTemplatingEngine templatingEngine,
ApplicationProperties applicationProperties,
ConstantsManager constantsManager,
PermissionManager permissionManager,
JiraAuthenticationContext authenticationContext,
PrioritySearchHandlerFactory handlerFactory,
JiraBaseUrls jiraBaseUrls,
BaseUrl baseUrl,
PrioritySchemeManager prioritySchemeManager,
I18nHelper.BeanFactory beanFactory,
PrioritySchemeUtil prioritySchemeUtil) |
| 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 OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value. |
void |
createValue(Issue issue,
Priority value)
Create the value of the issue in the data store.
|
List<Project> |
getAssociatedProjectObjects()
Returns a list of projects associated with this field.
|
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 |
getColumnHeadingKey() |
String |
getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
Map displayParams,
Issue issue) |
List<FieldConfigItemType> |
getConfigurationItemTypes()
Returns a List of
FieldConfigItemType objects. |
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.
|
Priority |
getDefaultPriority() |
String |
getDefaultSortOrder()
The order in which to sort the field when it is sorted for the first time.
|
Priority |
getDefaultValue(Issue issue)
The value that should be set on the issue if the field is not shown for some reason.
|
Priority |
getDefaultValue(IssueContext issueContext) |
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.
|
FieldTypeInfo |
getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
Returns lower level Information about the field.
|
Collection |
getIssueConstants() |
JsonData |
getJsonDefaultValue(IssueContext issueCtx)
Return The default data for this system field.
|
FieldJsonRepresentation |
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.
|
JsonType |
getJsonSchema()
Return a description of the shape of this field when represented as JSON.
|
static JsonType |
getPriorityJsonSchema() |
FieldConfig |
getRelevantConfig(IssueContext issueContext) |
protected Object |
getRelevantParams(Map<String,String[]> params) |
FieldExportParts |
getRepresentationFromIssue(Issue issue)
This outputs the name translation of the priority, e.g.
|
RestFieldOperationsHandler |
getRestFieldOperation() |
LuceneFieldSorter |
getSorter()
A sorter to be used when sorting columns in a table.
|
Priority |
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,
Priority priority,
Map displayParameters) |
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 |
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.
|
String |
prettyPrintChangeHistory(String changeHistory,
I18nHelper i18nHelper)
Return an internationalized value for the changeHistory item - a priority name in this case.
|
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
|
getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getSortFields, getVelocityParams, prettyPrintChangeHistorycreateAssociatedSearchHandler, getApplicationProperties, getCreateHtml, getEditHtml, getFieldLayoutItemForBulkOperation, getIssueForBulkOperation, getPermissionManager, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, validateBulkEditHtmlProperties, valuesEqualcompareTo, equals, getAuthenticationContext, getId, getName, getNameKey, hashCodeclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitgetCreateHtml, getEditHtml, getViewHtml, hasParam, populateFromParamscreateAssociatedSearchHandlergetId, getName, getNameKeycompareTopublic PrioritySystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, ConstantsManager constantsManager, PermissionManager permissionManager, JiraAuthenticationContext authenticationContext, PrioritySearchHandlerFactory handlerFactory, JiraBaseUrls jiraBaseUrls, BaseUrl baseUrl, PrioritySchemeManager prioritySchemeManager, I18nHelper.BeanFactory beanFactory, PrioritySchemeUtil prioritySchemeUtil)
public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
OrderableFieldgetCreateHtml in interface OrderableField<Priority>fieldLayoutItem - FieldLayoutItemoperationContext - OperationContextaction - Actionissue - IssuedisplayParameters - Map of display parameters.public String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
OrderableFieldgetEditHtml in interface OrderableField<Priority>fieldLayoutItem - FieldLayoutItemoperationContext - OperationContextaction - Actionissue - IssuedisplayParameters - Map of display parameters.public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
getViewHtml in interface OrderableField<Priority>public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Priority priority, Map displayParameters)
getViewHtml in interface OrderableField<Priority>public void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
OrderableFieldvalidateParams in interface OrderableField<Priority>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 - FieldScreenRenderLayoutItempublic Priority getValueFromParams(Map params)
OrderableFieldgetValueFromParams in interface OrderableField<Priority>params - the map of parameters.public void populateParamsFromString(Map<String,Object> fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationException
OrderableFieldpopulateParamsFromString in interface OrderableField<Priority>fieldValuesHolder - Map of field Values.stringValue - user friendly string valueissue - the IssueFieldValidationException - if cannot convert to a value from the given stringpublic void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
OrderableFieldFields 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.
updateValue in interface OrderableField<Priority>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 createValue(Issue issue, Priority value)
OrderableFieldcreateValue in interface OrderableField<Priority>issue - Issue this field is part ofvalue - Value to store in this field (eg. Collection for Version fields). Cannot be null.protected Object getRelevantParams(Map<String,String[]> params)
getRelevantParams in class AbstractOrderableField<Priority>public void populateFromIssue(Map<String,Object> fieldValuesHolder, Issue issue)
OrderableFieldpopulateFromIssue in interface OrderableField<Priority>fieldValuesHolder - The fieldValuesHolder Map to be populated.issue - The Issue.public boolean isShown(Issue issue)
OrderableFieldisShown in interface OrderableField<Priority>issue - The Issue.public void populateDefaults(Map<String,Object> fieldValuesHolder, Issue issue)
OrderableFieldpopulateDefaults in interface OrderableField<Priority>fieldValuesHolder - The fieldValuesHolder Map to be populated.issue - The Issue.public Priority getDefaultValue(Issue issue)
OrderableFieldFor example: The user does not have permission to see the field, or the field is not part of the create screen.
getDefaultValue in interface OrderableField<Priority>issue - the Issue.public Priority getDefaultValue(IssueContext issueContext)
public Priority getDefaultPriority()
public void updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder)
OrderableFieldupdateIssue in interface OrderableField<Priority>fieldLayoutItem - FieldLayoutItemissue - MutableIssuefieldValueHolder - Field Value Holder MapOrderableField.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)public MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)
OrderableFieldneedsMove in interface OrderableField<Priority>originalIssues - Collection of original Issues.targetIssue - Nonexistent issue object with values representing those of issue(s) after movetargetFieldLayoutItem - FieldLayoutItempublic void populateForMove(Map<String,Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue)
OrderableFieldOrderableField.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<Priority>fieldValuesHolder - Map of field Values.originalIssue - orignal IssuetargetIssue - target Issuepublic void removeValueFromIssueObject(MutableIssue issue)
OrderableFieldNote 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.
removeValueFromIssueObject in interface OrderableField<Priority>issue - The issue object to be effected.OrderableField.canRemoveValueFromIssueObject(com.atlassian.jira.issue.Issue),
OrderableField.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)public boolean canRemoveValueFromIssueObject(Issue issue)
OrderableFieldtrue if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.
There a few different reasons why this method may return false:
canRemoveValueFromIssueObject in interface OrderableField<Priority>issue - The Issue object.true if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)public boolean hasValue(Issue issue)
OrderableFieldhasValue in interface OrderableField<Priority>issue - the Issue.public String availableForBulkEdit(BulkEditBean bulkEditBean)
OrderableFieldavailableForBulkEdit in interface OrderableField<Priority>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.public String getBulkEditHtml(OperationContext operationContext, webwork.action.Action action, BulkEditBean bulkEditBean, Map displayParameters)
AbstractOrderableFieldOrderableField.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 for FieldLayoutItem and the first issue in the collection}getBulkEditHtml in interface OrderableField<Priority>getBulkEditHtml in class AbstractOrderableField<Priority>operationContext - OperationContextaction - ActionbulkEditBean - BulkEditBeandisplayParameters - Map of display parameters.public String getColumnHeadingKey()
getColumnHeadingKey in interface NavigableFieldpublic String getDefaultSortOrder()
NavigableFieldgetDefaultSortOrder in interface NavigableFieldNavigableField.ORDER_ASCENDING or NavigableField.ORDER_DESCENDINGpublic LuceneFieldSorter getSorter()
NavigableFieldgetSorter in interface NavigableFieldNavigableField.getSortComparatorSource()DocumentIssueImpl,
MappedSortComparatorpublic String getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
getColumnViewHtml in interface NavigableFieldpublic Collection getIssueConstants()
getIssueConstants in interface IssueConstantsFieldpublic String prettyPrintChangeHistory(String changeHistory, I18nHelper i18nHelper)
prettyPrintChangeHistory in interface NavigableFieldprettyPrintChangeHistory in class AbstractOrderableNavigableFieldImpl<Priority>changeHistory - name of priorityi18nHelper - used to translate the priority namepublic FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
RestAwareFieldgetFieldTypeInfo in interface RestAwareFieldfieldTypeInfoContext - the FieldTypeInfoContext contains context information that is relevant to generate the FieldTypeInfopublic JsonType getJsonSchema()
RestAwareFieldgetJsonSchema in interface RestAwareFieldpublic static JsonType getPriorityJsonSchema()
public RestFieldOperationsHandler getRestFieldOperation()
getRestFieldOperation in interface RestFieldOperationspublic FieldJsonRepresentation getJsonFromIssue(Issue issue, boolean renderedVersionRequired, FieldLayoutItem fieldLayoutItem)
RestAwareFieldgetJsonFromIssue in interface RestAwareFieldissue - 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.public JsonData getJsonDefaultValue(IssueContext issueCtx)
RestFieldOperationsgetJsonDefaultValue in interface RestFieldOperationsissueCtx - Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.public FieldExportParts getRepresentationFromIssue(Issue issue)
getRepresentationFromIssue in interface ExportableSystemFieldissue - to get representation for the fieldpublic List<FieldConfigItemType> getConfigurationItemTypes()
ConfigurableFieldFieldConfigItemType objects. This opens up possibilties for configurable custom fieldsgetConfigurationItemTypes in interface ConfigurableField<Priority>FieldConfigItemType @Nonnullpublic List<Project> getAssociatedProjectObjects()
ConfigurableFieldgetAssociatedProjectObjects in interface ConfigurableField<Priority>public FieldConfig getRelevantConfig(IssueContext issueContext)
getRelevantConfig in interface ConfigurableField<Priority>Copyright © 2002-2017 Atlassian. All Rights Reserved.