|
||||||||||
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.AbstractVersionsSystemField
public abstract class AbstractVersionsSystemField
Copyright (c) 2002-2004 All rights reserved.
Field Summary | |
---|---|
static Long |
RELEASED_VERSION_ID
|
static Long |
UNKNOWN_VERSION_ID
|
static Long |
UNRELEASED_VERSION_ID
|
Fields inherited from class com.atlassian.jira.issue.fields.AbstractField |
---|
authenticationContext |
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 | |
---|---|
AbstractVersionsSystemField(String id,
String name,
com.atlassian.velocity.VelocityManager velocityManager,
ApplicationProperties applicationProperties,
VersionManager versionManager,
PermissionManager permissionManager,
JiraAuthenticationContext authenticationContext,
VersionHelperBean versionHelperBean)
|
Method Summary | |
---|---|
protected abstract void |
addFieldRequiredErrorMessage(Issue issue,
ErrorCollection errorCollectionToAddTo,
I18nHelper i18n)
|
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. |
protected abstract String |
getArchivedVersionsFieldSearchParam()
|
protected abstract String |
getArchivedVersionsFieldTitle()
|
protected abstract String |
getChangeItemFieldName()
|
String |
getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
Map displayParams,
Issue issue)
|
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 |
protected Collection |
getCurrentVersionIds(Issue issue)
|
protected abstract Collection |
getCurrentVersions(Issue issue)
|
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. |
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 abstract String |
getIssueRelationName()
|
protected abstract String |
getModifiedWithoutPermissionErrorMessage(I18nHelper i18n)
|
protected List |
getPossibleVersions(org.ofbiz.core.entity.GenericValue project,
boolean unreleasedFirst)
|
protected Object |
getRelevantParams(Map params)
|
protected abstract boolean |
getUnreleasedVersionsFirst()
|
Object |
getValueFromParams(Map params)
Get a field value from the map of parameters passed. |
protected VersionManager |
getVersionManager()
|
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. |
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 params,
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 |
updateValue(FieldLayoutItem fieldLayoutItem,
Issue issue,
ModifiedValue modifiedValue,
IssueChangeHolder issueChangeHolder)
Update the issue in the data store |
void |
validateParams(OperationContext operationContext,
ErrorCollection errorCollection,
I18nHelper i18n,
Issue issue,
FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
Ensure that the parameters are valid |
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 |
---|
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.Field |
---|
getId, getName, getNameKey |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Methods inherited from interface com.atlassian.jira.issue.fields.NavigableField |
---|
getColumnHeadingKey, getSorter |
Methods inherited from interface com.atlassian.jira.issue.fields.OrderableField |
---|
isShown, removeValue, updateIssue |
Methods inherited from interface com.atlassian.jira.issue.fields.SearchableField |
---|
getAssociatedSearchers |
Field Detail |
---|
public static final Long UNKNOWN_VERSION_ID
public static final Long UNRELEASED_VERSION_ID
public static final Long RELEASED_VERSION_ID
Constructor Detail |
---|
public AbstractVersionsSystemField(String id, String name, com.atlassian.velocity.VelocityManager velocityManager, ApplicationProperties applicationProperties, VersionManager versionManager, PermissionManager permissionManager, JiraAuthenticationContext authenticationContext, VersionHelperBean versionHelperBean)
Method Detail |
---|
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
protected Object getRelevantParams(Map params)
getRelevantParams
in class AbstractOrderableField
public Object getValueFromParams(Map params)
OrderableField
getValueFromParams
in interface OrderableField
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 void populateFromIssue(Map params, Issue issue)
OrderableField
populateFromIssue
in interface OrderableField
protected Collection getCurrentVersionIds(Issue issue)
protected abstract Collection getCurrentVersions(Issue issue)
protected abstract String getArchivedVersionsFieldTitle()
protected abstract String getArchivedVersionsFieldSearchParam()
protected abstract boolean getUnreleasedVersionsFirst()
protected List getPossibleVersions(org.ofbiz.core.entity.GenericValue project, boolean unreleasedFirst)
public void validateParams(OperationContext operationContext, ErrorCollection errorCollection, 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 modifiedprotected abstract void addFieldRequiredErrorMessage(Issue issue, ErrorCollection errorCollectionToAddTo, I18nHelper i18n)
protected abstract String getModifiedWithoutPermissionErrorMessage(I18nHelper i18n)
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 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 boolean hasValue(Issue issue)
OrderableField
hasValue
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 populateDefaults(Map fieldValuesHolder, Issue issue)
OrderableField
populateDefaults
in interface OrderableField
public Object getDefaultValue(Issue issue)
OrderableField
getDefaultValue
in interface OrderableField
protected abstract String getChangeItemFieldName()
protected abstract String getIssueRelationName()
protected VersionManager getVersionManager()
public String getDefaultSortOrder()
NavigableField
getDefaultSortOrder
in interface NavigableField
NavigableField.ORDER_ASCENDING
or NavigableField.ORDER_DESCENDING
public String getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
getColumnViewHtml
in interface NavigableField
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 |