|
||||||||||
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.AbstractOrderableNavigableFieldImpl com.atlassian.jira.issue.fields.AbstractTextSystemField com.atlassian.jira.issue.fields.SummarySystemField
public class SummarySystemField
Copyright (c) 2002-2004 All rights reserved.
Field Summary |
---|
Fields inherited from class com.atlassian.jira.issue.fields.AbstractField |
---|
authenticationContext |
Fields inherited from interface com.atlassian.jira.issue.fields.SummaryField |
---|
MAX_LEN |
Fields inherited from interface com.atlassian.jira.issue.fields.NavigableField |
---|
ORDER_ASCENDING, ORDER_DESCENDING, TEMPLATE_DIRECTORY_PATH |
Fields inherited from interface com.atlassian.jira.issue.fields.OrderableField |
---|
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH |
Constructor Summary | |
---|---|
SummarySystemField(com.atlassian.velocity.VelocityManager velocityManager,
ApplicationProperties applicationProperties,
JiraAuthenticationContext authenticationContext,
RendererManager rendererManager,
PermissionManager permissionManager,
SummarySearchHandlerFactory searchHandlerFactory)
|
Method Summary | |
---|---|
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. |
String |
getColumnHeadingKey()
|
protected String |
getColumnViewTemplateName()
|
String |
getDefaultSortOrder()
The order in which to sort the field when it is sorted for the first time. |
Object |
getDefaultValue(Issue issue)
The value that should be set on the issue if the field is not shown for some reason. |
protected String |
getEditTemplateName()
|
JsonData |
getJsonDefaultValue(IssueContext issueCtx)
Return The default data for this system field. |
RestFieldOperationsHandler |
getRestFieldOperation()
|
LuceneFieldSorter |
getSorter()
A sorter to be used when sorting columns in a table. |
String |
getValueFromIssue(Issue issue)
Gets the value stored for this field on the provided 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. |
void |
populateFromIssue(Map fieldValuesHolder,
Issue issue)
Used to initialise the fieldValuesHolder from the current value of teh issue. |
protected void |
populateVelocityParams(FieldLayoutItem fieldLayoutItem,
Issue issue,
Map params)
|
protected void |
populateVelocityParams(Map fieldValuesHolder,
Map params)
|
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 |
validateParams(OperationContext operationContext,
ErrorCollection errorCollectionToAddTo,
I18nHelper i18n,
Issue issue,
FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
validate the field value |
Methods inherited from class com.atlassian.jira.issue.fields.AbstractTextSystemField |
---|
createValue, getChangeLogFieldName, getChangelogValue, getColumnViewHtml, getCreateHtml, getEditHtml, getFieldTypeInfo, getJsonFromIssue, getJsonSchema, getRelevantParams, getValueFromParams, getViewHtml, getViewHtml, hasValue, isInvertCollapsedState, needsMove, populateDefaults, populateForMove, populateParamsFromString, updateValue, valuesEqual |
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableNavigableFieldImpl |
---|
getColumnCssClass, getHiddenFieldId, getSortComparatorSource, getVelocityParams, prettyPrintChangeHistory, prettyPrintChangeHistory |
Methods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField |
---|
createAssociatedSearchHandler, getApplicationProperties, getBulkEditHtml, getCreateHtml, getEditHtml, getPermissionManager, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, 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.NavigableField |
---|
getColumnCssClass, getColumnViewHtml, getHiddenFieldId, getSortComparatorSource, prettyPrintChangeHistory, prettyPrintChangeHistory |
Methods inherited from interface com.atlassian.jira.issue.fields.renderer.RenderableField |
---|
getId |
Methods inherited from interface com.atlassian.jira.issue.fields.OrderableField |
---|
createValue, getBulkEditHtml, getCreateHtml, getCreateHtml, getEditHtml, getEditHtml, getValueFromParams, getViewHtml, getViewHtml, getViewHtml, hasParam, hasValue, needsMove, populateDefaults, populateForMove, populateFromParams, populateParamsFromString, updateValue |
Methods inherited from interface com.atlassian.jira.issue.fields.SearchableField |
---|
createAssociatedSearchHandler |
Methods inherited from interface com.atlassian.jira.issue.fields.Field |
---|
getId, getName, getNameKey |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Constructor Detail |
---|
public SummarySystemField(com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, RendererManager rendererManager, PermissionManager permissionManager, SummarySearchHandlerFactory searchHandlerFactory)
Method Detail |
---|
protected String getEditTemplateName()
getEditTemplateName
in class AbstractTextSystemField
protected String getColumnViewTemplateName()
getColumnViewTemplateName
in class AbstractTextSystemField
protected void populateVelocityParams(Map fieldValuesHolder, Map params)
populateVelocityParams
in class AbstractTextSystemField
protected void populateVelocityParams(FieldLayoutItem fieldLayoutItem, Issue issue, Map params)
populateVelocityParams
in class AbstractTextSystemField
public String getValueFromIssue(Issue issue)
RenderableField
getValueFromIssue
in interface RenderableField
getValueFromIssue
in class AbstractTextSystemField
issue
- identifies the issue that will contain the value for this field.
public void updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder)
OrderableField
updateIssue
in interface OrderableField
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 void removeValueFromIssueObject(MutableIssue issue)
OrderableField
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.
removeValueFromIssueObject
in interface OrderableField
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)
OrderableField
true
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
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 void populateFromIssue(Map fieldValuesHolder, Issue issue)
OrderableField
populateFromIssue
in interface OrderableField
populateFromIssue
in class AbstractTextSystemField
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The Issue.public boolean isShown(Issue issue)
OrderableField
isShown
in interface OrderableField
issue
- The Issue.
public void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
validateParams
in interface OrderableField
operationContext
- OperationContexterrorCollectionToAddTo
- ErrorCollectioni18n
- I18nHelperissue
- IssuefieldScreenRenderLayoutItem
- FieldScreenRenderLayoutItempublic Object getDefaultValue(Issue issue)
OrderableField
For 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
issue
- the Issue.
public String getColumnHeadingKey()
getColumnHeadingKey
in interface NavigableField
public String getDefaultSortOrder()
NavigableField
getDefaultSortOrder
in interface NavigableField
NavigableField.ORDER_ASCENDING
or NavigableField.ORDER_DESCENDING
public LuceneFieldSorter getSorter()
NavigableField
getSorter
in interface NavigableField
NavigableField.getSortComparatorSource()
DocumentIssueImpl
,
MappedSortComparator
public boolean isRenderable()
RenderableField
isRenderable
in interface RenderableField
isRenderable
in class AbstractTextSystemField
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)
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 RestFieldOperationsHandler getRestFieldOperation()
getRestFieldOperation
in interface RestFieldOperations
public JsonData getJsonDefaultValue(IssueContext issueCtx)
RestFieldOperations
getJsonDefaultValue
in interface RestFieldOperations
issueCtx
- Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |