Package com.atlassian.greenhopper.manager.issue.fields

Class StoryPointsCustomFieldProvider

java.lang.Object

com.atlassian.greenhopper.manager.issue.fields.AbstractDefaultCustomFieldProvider

com.atlassian.greenhopper.manager.issue.fields.StoryPointsCustomFieldProvider

All Implemented Interfaces:

DefaultCustomFieldProvider

public class StoryPointsCustomFieldProvider
extends AbstractDefaultCustomFieldProvider

Provides information about the default instance of the Story Points field. This field is used in JIRA Agile to allow users to estimate issues in the standard Scrum practise.

Since:

7.1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final CustomFieldMetadata	CUSTOMFIELD_METADATA	the meta-data needed to define the custom field in JIRA
static final String	SP_FIELD
static final String	SP_FIELD_DESC

Fields inherited from class com.atlassian.greenhopper.manager.issue.fields.AbstractDefaultCustomFieldProvider

customFieldMetadata, customFieldService, jiraAuthenticationContext, log

Constructor Summary

Constructors

Constructor	Description
StoryPointsCustomFieldProvider(CustomFieldService customFieldService, com.atlassian.jira.security.JiraAuthenticationContext jiraAuthenticationContext, com.atlassian.jira.config.ReindexMessageManager reindexMessageManager, com.atlassian.beehive.ClusterLockService clusterLockService, ManagedFieldPropertyDao managedFieldPropertyDao)

Method Summary

Modifier and Type	Method	Description
void	ensureFieldHasCorrectContext()	Story Points field is not strictly managed: it is created as a default, and then administrators can change its configuration.
protected Long	getStoredCustomFieldId()
protected void	setStoredCustomFieldId(Long id)	Persist the custom field ID for later retrieval

Methods inherited from class com.atlassian.greenhopper.manager.issue.fields.AbstractDefaultCustomFieldProvider

afterFieldIsProduced, doesDefaultFieldExist, getOrCreateDefaultField

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SP_FIELD

public static final String SP_FIELD

See Also:

• Constant Field Values

SP_FIELD_DESC

public static final String SP_FIELD_DESC

See Also:

• Constant Field Values

CUSTOMFIELD_METADATA

public static final CustomFieldMetadata CUSTOMFIELD_METADATA

the meta-data needed to define the custom field in JIRA

Constructor Details

StoryPointsCustomFieldProvider

public StoryPointsCustomFieldProvider(CustomFieldService customFieldService,
 com.atlassian.jira.security.JiraAuthenticationContext jiraAuthenticationContext,
 com.atlassian.jira.config.ReindexMessageManager reindexMessageManager,
 com.atlassian.beehive.ClusterLockService clusterLockService,
 ManagedFieldPropertyDao managedFieldPropertyDao)

Method Details

ensureFieldHasCorrectContext

public void ensureFieldHasCorrectContext()

Story Points field is not strictly managed: it is created as a default, and then administrators can change its configuration. In this method we simply check, if the field does exist, make sure that it has at least one FieldConfigScheme. If it has none, it will create one associated to the Epic and Story issue types.

getStoredCustomFieldId

@Nullable
protected Long getStoredCustomFieldId()

Specified by:

getStoredCustomFieldId in class AbstractDefaultCustomFieldProvider

Returns:

the currently persisted custom field ID

setStoredCustomFieldId

protected void setStoredCustomFieldId(@Nullable
 Long id)

Description copied from class: AbstractDefaultCustomFieldProvider

Persist the custom field ID for later retrieval

Specified by:

setStoredCustomFieldId in class AbstractDefaultCustomFieldProvider

Parameters:

id - the custom field ID